CfnDomainProps
- class aws_cdk.aws_amplify.CfnDomainProps(*, 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:
object
Properties for defining a
CfnDomain
.- Parameters:
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.
- 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_props = amplify.CfnDomainProps( 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 )
Attributes
- app_id
The unique ID for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
- 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.+
- 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.
- sub_domain_settings
The setting for the subdomain.