CfnEnvironmentPropsMixin

class aws_cdk.mixins_preview.aws_finspace.mixins.CfnEnvironmentPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html
CloudformationResource:: AWS::FinSpace::Environment
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_environment_props_mixin = finspace_mixins.CfnEnvironmentPropsMixin(finspace_mixins.CfnEnvironmentMixinProps(
    data_bundles=["dataBundles"],
    description="description",
    federation_mode="federationMode",
    federation_parameters=finspace_mixins.CfnEnvironmentPropsMixin.FederationParametersProperty(
        application_call_back_url="applicationCallBackUrl",
        attribute_map=[finspace_mixins.CfnEnvironmentPropsMixin.AttributeMapItemsProperty(
            key="key",
            value="value"
        )],
        federation_provider_name="federationProviderName",
        federation_urn="federationUrn",
        saml_metadata_document="samlMetadataDocument",
        saml_metadata_url="samlMetadataUrl"
    ),
    kms_key_id="kmsKeyId",
    name="name",
    superuser_parameters=finspace_mixins.CfnEnvironmentPropsMixin.SuperuserParametersProperty(
        email_address="emailAddress",
        first_name="firstName",
        last_name="lastName"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::FinSpace::Environment.

Parameters:

props (Union[CfnEnvironmentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataBundles', 'description', 'federationMode', 'federationParameters', 'kmsKeyId', 'name', 'superuserParameters', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AttributeMapItemsProperty

class CfnEnvironmentPropsMixin.AttributeMapItemsProperty(*, key=None, value=None)

Bases: object

Parameters:

key (Optional[str]) – The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value (Optional[str]) – The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

attribute_map_items_property = finspace_mixins.CfnEnvironmentPropsMixin.AttributeMapItemsProperty(
    key="key",
    value="value"
)

Attributes

key

The key name of the tag.

You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-attributemapitems.html#cfn-finspace-environment-attributemapitems-key

value

The value for the tag.

You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-attributemapitems.html#cfn-finspace-environment-attributemapitems-value

FederationParametersProperty

class CfnEnvironmentPropsMixin.FederationParametersProperty(*, application_call_back_url=None, attribute_map=None, federation_provider_name=None, federation_urn=None, saml_metadata_document=None, saml_metadata_url=None)

Bases: object

Configuration information when authentication mode is FEDERATED.

Parameters:

application_call_back_url (Optional[str]) – The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
attribute_map (Union[IResolvable, Sequence[Union[IResolvable, AttributeMapItemsProperty, Dict[str, Any]]], None]) – SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress . Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
federation_provider_name (Optional[str]) – Name of the identity provider (IdP).
federation_urn (Optional[str]) – The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
saml_metadata_document (Optional[str]) – SAML 2.0 Metadata document from identity provider (IdP).
saml_metadata_url (Optional[str]) – Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

federation_parameters_property = finspace_mixins.CfnEnvironmentPropsMixin.FederationParametersProperty(
    application_call_back_url="applicationCallBackUrl",
    attribute_map=[finspace_mixins.CfnEnvironmentPropsMixin.AttributeMapItemsProperty(
        key="key",
        value="value"
    )],
    federation_provider_name="federationProviderName",
    federation_urn="federationUrn",
    saml_metadata_document="samlMetadataDocument",
    saml_metadata_url="samlMetadataUrl"
)

Attributes

application_call_back_url

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-applicationcallbackurl

attribute_map

SAML attribute name and value.

The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress . Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-attributemap

federation_provider_name

Name of the identity provider (IdP).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-federationprovidername

federation_urn

The Uniform Resource Name (URN).

Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-federationurn

saml_metadata_document

SAML 2.0 Metadata document from identity provider (IdP).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-samlmetadatadocument

saml_metadata_url

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-federationparameters.html#cfn-finspace-environment-federationparameters-samlmetadataurl

SuperuserParametersProperty

class CfnEnvironmentPropsMixin.SuperuserParametersProperty(*, email_address=None, first_name=None, last_name=None)

Bases: object

Configuration information for the superuser.

Parameters:

email_address (Optional[str]) – The email address of the superuser.
first_name (Optional[str]) – The first name of the superuser.
last_name (Optional[str]) – The last name of the superuser.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

superuser_parameters_property = finspace_mixins.CfnEnvironmentPropsMixin.SuperuserParametersProperty(
    email_address="emailAddress",
    first_name="firstName",
    last_name="lastName"
)

Attributes

email_address

The email address of the superuser.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html#cfn-finspace-environment-superuserparameters-emailaddress

first_name

The first name of the superuser.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html#cfn-finspace-environment-superuserparameters-firstname

last_name

The last name of the superuser.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-finspace-environment-superuserparameters.html#cfn-finspace-environment-superuserparameters-lastname