CfnDomainProps

class aws_cdk.aws_amplify.CfnDomainProps(*, app_id, auto_sub_domain_creation_patterns=None, auto_sub_domain_iam_role=None, domain_name, enable_auto_sub_domain=None, sub_domain_settings)

Bases: object

Properties for defining a AWS::Amplify::Domain.

Parameters
  • app_id (str) – AWS::Amplify::Domain.AppId.

  • auto_sub_domain_creation_patterns (Optional[Sequence[str]]) – AWS::Amplify::Domain.AutoSubDomainCreationPatterns.

  • auto_sub_domain_iam_role (Optional[str]) – AWS::Amplify::Domain.AutoSubDomainIAMRole.

  • domain_name (str) – AWS::Amplify::Domain.DomainName.

  • enable_auto_sub_domain (Union[bool, IResolvable, None]) – AWS::Amplify::Domain.EnableAutoSubDomain.

  • sub_domain_settings (Union[IResolvable, Sequence[Union[IResolvable, SubDomainSettingProperty]]]) – AWS::Amplify::Domain.SubDomainSettings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html

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

AWS::Amplify::Domain.AppId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid

Return type

str

auto_sub_domain_creation_patterns

AWS::Amplify::Domain.AutoSubDomainCreationPatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns

Return type

Optional[List[str]]

auto_sub_domain_iam_role

AWS::Amplify::Domain.AutoSubDomainIAMRole.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole

Return type

Optional[str]

domain_name

AWS::Amplify::Domain.DomainName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname

Return type

str

enable_auto_sub_domain

AWS::Amplify::Domain.EnableAutoSubDomain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain

Return type

Union[bool, IResolvable, None]

sub_domain_settings

AWS::Amplify::Domain.SubDomainSettings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings

Return type

Union[IResolvable, List[Union[IResolvable, SubDomainSettingProperty]]]