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=None, certificate_settings=None, enable_auto_sub_domain=None, update_status=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 (Union[IResolvable, CertificateProperty, Dict[str, Any], None]) – Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you. If you are updating your domain to use a different certificate, Certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, Certificate points to the current active certificate.

  • 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.

  • update_status (Optional[str]) – The status of the domain update operation that is currently in progress. The following list describes the valid update states. - REQUESTING_CERTIFICATE - The certificate is in the process of being updated. - PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate. - IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate. - PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated. - AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide . - UPDATE_COMPLETE - The certificate has been associated with a domain. - UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

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=amplify.CfnDomain.CertificateProperty(
        certificate_arn="certificateArn",
        certificate_type="certificateType",
        certificate_verification_dns_record="certificateVerificationDnsRecord"
    ),
    certificate_settings=amplify.CfnDomain.CertificateSettingsProperty(
        certificate_type="certificateType",
        custom_certificate_arn="customCertificateArn"
    ),
    enable_auto_sub_domain=False,
    update_status="updateStatus"
)

Attributes

app_id

The unique ID for an Amplify app.

See:

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

auto_sub_domain_creation_patterns

Sets the branch patterns for automatic subdomain creation.

See:

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

auto_sub_domain_iam_role

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

See:

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

certificate

Describes the SSL/TLS certificate for the domain association.

This can be your own custom certificate or the default certificate that Amplify provisions for you.

If you are updating your domain to use a different certificate, Certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, Certificate points to the current active certificate.

See:

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

certificate_settings

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.

See:

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

domain_name

The domain name for the domain association.

See:

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

enable_auto_sub_domain

Enables the automated creation of subdomains for branches.

See:

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

sub_domain_settings

The setting for the subdomain.

See:

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

update_status

The status of the domain update operation that is currently in progress.

The following list describes the valid update states.

  • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.

  • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

  • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

  • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.

  • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .

  • UPDATE_COMPLETE - The certificate has been associated with a domain.

  • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

See:

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