CfnDomainMixinProps

class aws_cdk.mixins_preview.aws_amplify.mixins.CfnDomainMixinProps(*, app_id=None, auto_sub_domain_creation_patterns=None, auto_sub_domain_iam_role=None, certificate_settings=None, domain_name=None, enable_auto_sub_domain=None, sub_domain_settings=None)

Bases: object

Properties for CfnDomainPropsMixin.

Parameters:

app_id (Optional[str]) – The unique ID for an Amplify app.
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.
domain_name (Optional[str]) – The domain name for the domain association.
enable_auto_sub_domain (Union[bool, IResolvable, None]) – Enables the automated creation of subdomains for branches.
sub_domain_settings (Union[IResolvable, Sequence[Union[IResolvable, SubDomainSettingProperty, Dict[str, Any]]], None]) – The setting for the subdomain.

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.mixins_preview.aws_amplify import mixins as amplify_mixins

cfn_domain_mixin_props = amplify_mixins.CfnDomainMixinProps(
    app_id="appId",
    auto_sub_domain_creation_patterns=["autoSubDomainCreationPatterns"],
    auto_sub_domain_iam_role="autoSubDomainIamRole",
    certificate_settings=amplify_mixins.CfnDomainPropsMixin.CertificateSettingsProperty(
        certificate_type="certificateType",
        custom_certificate_arn="customCertificateArn"
    ),
    domain_name="domainName",
    enable_auto_sub_domain=False,
    sub_domain_settings=[amplify_mixins.CfnDomainPropsMixin.SubDomainSettingProperty(
        branch_name="branchName",
        prefix="prefix"
    )]
)