CfnEnvironmentProps

class aws_cdk.aws_finspace.CfnEnvironmentProps(*, name, description=None, federation_mode=None, federation_parameters=None, kms_key_id=None, superuser_parameters=None, tags=None)

Bases: object

Properties for defining a CfnEnvironment.

Parameters:

name (str) – The name of the FinSpace environment.
description (Optional[str]) – The description of the FinSpace environment.
federation_mode (Optional[str]) – The authentication mode for the environment.
federation_parameters (Union[FederationParametersProperty, Dict[str, Any], IResolvable, None]) – Configuration information when authentication mode is FEDERATED.
kms_key_id (Optional[str]) – The KMS key id used to encrypt in the FinSpace environment.
superuser_parameters (Union[IResolvable, SuperuserParametersProperty, Dict[str, Any], None]) – Configuration information for the superuser.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – AWS::FinSpace::Environment.Tags.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_finspace as finspace

cfn_environment_props = finspace.CfnEnvironmentProps(
    name="name",

    # the properties below are optional
    description="description",
    federation_mode="federationMode",
    federation_parameters=finspace.CfnEnvironment.FederationParametersProperty(
        application_call_back_url="applicationCallBackUrl",
        attribute_map=[finspace.CfnEnvironment.AttributeMapItemsProperty(
            key="key",
            value="value"
        )],
        federation_provider_name="federationProviderName",
        federation_urn="federationUrn",
        saml_metadata_document="samlMetadataDocument",
        saml_metadata_url="samlMetadataUrl"
    ),
    kms_key_id="kmsKeyId",
    superuser_parameters=finspace.CfnEnvironment.SuperuserParametersProperty(
        email_address="emailAddress",
        first_name="firstName",
        last_name="lastName"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)