class Aws::Finspace::Types::UpdateEnvironmentRequest

@note When making an API call, you may pass UpdateEnvironmentRequest

data as a hash:

    {
      environment_id: "IdType", # required
      name: "EnvironmentName",
      description: "Description",
      federation_mode: "FEDERATED", # accepts FEDERATED, LOCAL
      federation_parameters: {
        saml_metadata_document: "SamlMetadataDocument",
        saml_metadata_url: "url",
        application_call_back_url: "url",
        federation_urn: "urn",
        federation_provider_name: "FederationProviderName",
        attribute_map: {
          "FederationAttributeKey" => "url",
        },
      },
    }

@!attribute [rw] environment_id

The identifier of the FinSpace environment.
@return [String]

@!attribute [rw] name

The name of the environment.
@return [String]

@!attribute [rw] description

The description of the environment.
@return [String]

@!attribute [rw] federation_mode

Authentication mode for the environment.

* `FEDERATED` - Users access FinSpace through Single Sign On (SSO)
  via your Identity provider.

* `LOCAL` - Users access FinSpace via email and password managed
  within the FinSpace environment.
@return [String]

@!attribute [rw] federation_parameters

Configuration information when authentication mode is FEDERATED.
@return [Types::FederationParameters]

@see docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateEnvironmentRequest AWS API Documentation

Constants

SENSITIVE