CfnEnvironmentProps

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

Bases: object

Properties for defining a CfnEnvironment.

Parameters
  • name (str) – The name of the FinSpace environment.

  • data_bundles (Optional[Sequence[str]]) – The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:. - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies. - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

  • description (Optional[str]) – The description of the FinSpace environment.

  • federation_mode (Optional[str]) – The authentication mode for the environment.

  • federation_parameters (Union[FederationParametersProperty, 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, None]) – Configuration information for the superuser.

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

# attribute_map: Any

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

    # the properties below are optional
    data_bundles=["dataBundles"],
    description="description",
    federation_mode="federationMode",
    federation_parameters=finspace.CfnEnvironment.FederationParametersProperty(
        application_call_back_url="applicationCallBackUrl",
        attribute_map=attribute_map,
        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"
    )
)

Attributes

data_bundles

.

  • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

  • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Link

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

Type

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs

Return type

Optional[List[str]]

description

The description of the FinSpace environment.

Link

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

Return type

Optional[str]

federation_mode

The authentication mode for the environment.

Link

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

Return type

Optional[str]

federation_parameters

Configuration information when authentication mode is FEDERATED.

Link

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

Return type

Union[FederationParametersProperty, IResolvable, None]

kms_key_id

The KMS key id used to encrypt in the FinSpace environment.

Link

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

Return type

Optional[str]

name

The name of the FinSpace environment.

Link

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

Return type

str

superuser_parameters

Configuration information for the superuser.

Link

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

Return type

Union[IResolvable, SuperuserParametersProperty, None]