class Aws::Finspace::Types::CreateEnvironmentRequest
@note When making an API call, you may pass CreateEnvironmentRequest
data as a hash: { name: "EnvironmentName", # required description: "Description", kms_key_id: "KmsKeyId", tags: { "TagKey" => "TagValue", }, 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] name
The name of the FinSpace environment to be created. @return [String]
@!attribute [rw] description
The description of the FinSpace environment to be created. @return [String]
@!attribute [rw] kms_key_id
The KMS key id to encrypt your data in the FinSpace environment. @return [String]
@!attribute [rw] tags
Add tags to your FinSpace environment. @return [Hash<String,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/CreateEnvironmentRequest AWS API Documentation
Constants
- SENSITIVE