CfnEnvironment
- class aws_cdk.aws_finspace.CfnEnvironment(scope, id, *, name, data_bundles=None, description=None, federation_mode=None, federation_parameters=None, kms_key_id=None, superuser_parameters=None, tags=None)
Bases:
CfnResourceThe
AWS::FinSpace::Environmentresource represents an Amazon FinSpace environment.- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html
- CloudformationResource:
AWS::FinSpace::Environment
- 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 import aws_finspace as finspace cfn_environment = finspace.CfnEnvironment(self, "MyCfnEnvironment", 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=[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" )] )
- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).name (
str) – The name of the FinSpace environment.data_bundles (
Optional[Sequence[str]]) – (deprecated) ARNs of FinSpace Data Bundles to install.description (
Optional[str]) – The description of the FinSpace environment.federation_mode (
Optional[str]) – The authentication mode for the environment.federation_parameters (
Union[IResolvable,FederationParametersProperty,Dict[str,Any],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]]]]) – An array of key-value pairs to apply to this resource.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::FinSpace::Environment'
- attr_aws_account_id
The ID of the AWS account in which the FinSpace environment is created.
- CloudformationAttribute:
AwsAccountId
- attr_dedicated_service_account_id
The AWS account ID of the dedicated service account associated with your FinSpace environment.
- CloudformationAttribute:
DedicatedServiceAccountId
- attr_environment_arn
The Amazon Resource Name (ARN) of your FinSpace environment.
- CloudformationAttribute:
EnvironmentArn
- attr_environment_id
The identifier of the FinSpace environment.
- CloudformationAttribute:
EnvironmentId
- attr_environment_url
The sign-in url for the web application of your FinSpace environment.
- CloudformationAttribute:
EnvironmentUrl
- attr_sage_maker_studio_domain_url
The url of the integrated FinSpace notebook environment in your web application.
- CloudformationAttribute:
SageMakerStudioDomainUrl
- attr_status
The current status of creation of the FinSpace environment.
- CloudformationAttribute:
Status
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- data_bundles
(deprecated) ARNs of FinSpace Data Bundles to install.
- Deprecated:
this property has been deprecated
- Stability:
deprecated
- description
The description of the FinSpace environment.
- federation_mode
The authentication mode for the environment.
- federation_parameters
Configuration information when authentication mode is FEDERATED.
- kms_key_id
The KMS key id used to encrypt in the FinSpace environment.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the FinSpace environment.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- superuser_parameters
Configuration information for the superuser.
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
An array of key-value pairs to apply to this resource.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any) –- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AttributeMapItemsProperty
- class CfnEnvironment.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:
- 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 import aws_finspace as finspace attribute_map_items_property = finspace.CfnEnvironment.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 -.
- 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 -.
FederationParametersProperty
- class CfnEnvironment.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:
objectConfiguration 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 beEmailand the value should be set to the attribute definition in which user email is set. For example, name would beEmailand valuehttp://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:
- 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 import aws_finspace as finspace federation_parameters_property = 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" )
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).
- attribute_map
SAML attribute name and value.
The name must always be
Emailand the value should be set to the attribute definition in which user email is set. For example, name would beEmailand valuehttp://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
Name of the identity provider (IdP).
- federation_urn
The Uniform Resource Name (URN).
Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
- saml_metadata_document
SAML 2.0 Metadata document from identity provider (IdP).
- saml_metadata_url
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
SuperuserParametersProperty
- class CfnEnvironment.SuperuserParametersProperty(*, email_address=None, first_name=None, last_name=None)
Bases:
objectConfiguration 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:
- 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 import aws_finspace as finspace superuser_parameters_property = finspace.CfnEnvironment.SuperuserParametersProperty( email_address="emailAddress", first_name="firstName", last_name="lastName" )
Attributes
- email_address
The email address of the superuser.
- first_name
The first name of the superuser.
- last_name
The last name of the superuser.