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, certificate_settings=None, enable_auto_sub_domain=None)

Bases: object

Properties for defining a CfnDomain.

Parameters:

app_id (str) – The unique ID for an Amplify app.
domain_name (str) – The domain name for the domain association.
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 (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificate_settings (Union[IResolvable, CertificateSettingsProperty, Dict[str, Any], None]) – The type of SSL/TLS certificate to use for your custom domain. If you don’t specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
enable_auto_sub_domain (Union[bool, IResolvable, None]) – Enables the automated creation of subdomains for branches.

See:

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.
from aws_cdk import 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",
    certificate_settings=amplify.CfnDomain.CertificateSettingsProperty(
        certificate_type="certificateType",
        custom_certificate_arn="customCertificateArn"
    ),
    enable_auto_sub_domain=False
)