CfnDomain
- class aws_cdk.aws_amplify.CfnDomain(scope, id, *, app_id, domain_name, sub_domain_settings, auto_sub_domain_creation_patterns=None, auto_sub_domain_iam_role=None, enable_auto_sub_domain=None)
Bases:
CfnResourceA CloudFormation
AWS::Amplify::Domain.The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
- CloudformationResource:
AWS::Amplify::Domain
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.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_amplify as amplify cfn_domain = amplify.CfnDomain(self, "MyCfnDomain", app_id="appId", domain_name="domainName", sub_domain_settings=[amplify.CfnDomain.SubDomainSettingProperty( branch_name="branchName", prefix="prefix" )], # the properties below are optional auto_sub_domain_creation_patterns=["autoSubDomainCreationPatterns"], auto_sub_domain_iam_role="autoSubDomainIamRole", enable_auto_sub_domain=False )
Create a new
AWS::Amplify::Domain.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
app_id (
str) – The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+domain_name (
str) – The domain name for the domain association. Length Constraints: Maximum length of 255. Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9]).)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(.)?$sub_domain_settings (
Union[IResolvable,Sequence[Union[IResolvable,SubDomainSettingProperty,Dict[str,Any]]]]) – The setting for the subdomain.auto_sub_domain_creation_patterns (
Optional[Sequence[str]]) – Sets the branch patterns for automatic subdomain creation.auto_sub_domain_iam_role (
Optional[str]) – The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. Length Constraints: Maximum length of 1000. Pattern: ^$|^arn:aws:iam::d{12}:role.+enable_auto_sub_domain (
Union[bool,IResolvable,None]) – Enables the automated creation of subdomains for branches.
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_depends_on(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_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
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 intermdediate 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).- 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 resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
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
- 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
- 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::Amplify::Domain'
- app_id
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
- attr_arn
ARN for the Domain Association.
- CloudformationAttribute:
Arn
- attr_auto_sub_domain_creation_patterns
Branch patterns for the automatically created subdomain.
- CloudformationAttribute:
AutoSubDomainCreationPatterns
- attr_auto_sub_domain_iam_role
The IAM service role for the subdomain.
- CloudformationAttribute:
AutoSubDomainIAMRole
- attr_certificate_record
DNS Record for certificate verification.
- CloudformationAttribute:
CertificateRecord
- attr_domain_name
Name of the domain.
- CloudformationAttribute:
DomainName
- attr_domain_status
Status for the Domain Association.
- CloudformationAttribute:
DomainStatus
- attr_enable_auto_sub_domain
Specifies whether the automated creation of subdomains for branches is enabled.
- CloudformationAttribute:
EnableAutoSubDomain
- attr_status_reason
Reason for the current status of the domain.
- CloudformationAttribute:
StatusReason
- auto_sub_domain_creation_patterns
Sets the branch patterns for automatic subdomain creation.
- auto_sub_domain_iam_role
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::d{12}:role.+
- 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.
- domain_name
The domain name for the domain association.
Length Constraints: Maximum length of 255.
Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9]).)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(.)?$
- enable_auto_sub_domain
Enables the automated creation of subdomains for branches.
- 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.
- node
The construct tree node associated with this construct.
- 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).
- sub_domain_settings
The setting for the subdomain.
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(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any)- Return type:
bool
SubDomainSettingProperty
- class CfnDomain.SubDomainSettingProperty(*, branch_name, prefix)
Bases:
objectThe SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.
- Parameters:
branch_name (
str) – The branch name setting for the subdomain. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+prefix (
str) – The prefix setting for the subdomain. Length Constraints: Maximum length of 255. Pattern: (?s).*
- Link:
- 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_amplify as amplify sub_domain_setting_property = amplify.CfnDomain.SubDomainSettingProperty( branch_name="branchName", prefix="prefix" )
Attributes
- branch_name
The branch name setting for the subdomain.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
- prefix
The prefix setting for the subdomain.
Length Constraints: Maximum length of 255.
Pattern: (?s).*