CfnDomainPropsMixin

class aws_cdk.mixins_preview.aws_amplify.mixins.CfnDomainPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html
CloudformationResource:: AWS::Amplify::Domain
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_amplify import mixins as amplify_mixins

cfn_domain_props_mixin = amplify_mixins.CfnDomainPropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Amplify::Domain.

Parameters:

props (Union[CfnDomainMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['appId', 'autoSubDomainCreationPatterns', 'autoSubDomainIamRole', 'certificateSettings', 'domainName', 'enableAutoSubDomain', 'subDomainSettings']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CertificateProperty

class CfnDomainPropsMixin.CertificateProperty(*, certificate_arn=None, certificate_type=None, certificate_verification_dns_record=None)

Bases: object

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.

Parameters:

certificate_arn (Optional[str]) – The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your AWS account . This field is required only when the certificate type is CUSTOM .
certificate_type (Optional[str]) – The type of SSL/TLS certificate that you want to use. Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you. Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .
certificate_verification_dns_record (Optional[str]) – The DNS record for certificate verification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificate.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

certificate_property = amplify_mixins.CfnDomainPropsMixin.CertificateProperty(
    certificate_arn="certificateArn",
    certificate_type="certificateType",
    certificate_verification_dns_record="certificateVerificationDnsRecord"
)

Attributes

certificate_arn

The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

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

certificate_type

The type of SSL/TLS certificate that you want to use.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .

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

certificate_verification_dns_record

The DNS record for certificate verification.

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

CertificateSettingsProperty

class CfnDomainPropsMixin.CertificateSettingsProperty(*, certificate_type=None, custom_certificate_arn=None)

Bases: object

The type of SSL/TLS certificate to use for your custom domain.

If a certificate type isn’t specified, Amplify uses the default AMPLIFY_MANAGED certificate.

Parameters:

certificate_type (Optional[str]) –
The certificate type. Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you. Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .
custom_certificate_arn (Optional[str]) – The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your AWS account . This field is required only when the certificate type is CUSTOM .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-certificatesettings.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

certificate_settings_property = amplify_mixins.CfnDomainPropsMixin.CertificateSettingsProperty(
    certificate_type="certificateType",
    custom_certificate_arn="customCertificateArn"
)

Attributes

certificate_type

The certificate type.

Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.

Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .

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

custom_certificate_arn

The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your AWS account .

This field is required only when the certificate type is CUSTOM .

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

SubDomainSettingProperty

class CfnDomainPropsMixin.SubDomainSettingProperty(*, branch_name=None, prefix=None)

Bases: object

The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.

Parameters:

branch_name (Optional[str]) – The branch name setting for the subdomain. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+
prefix (Optional[str]) – The prefix setting for the subdomain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.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

sub_domain_setting_property = amplify_mixins.CfnDomainPropsMixin.SubDomainSettingProperty(
    branch_name="branchName",
    prefix="prefix"
)

Attributes

branch_name

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-branchname

prefix

The prefix setting for the subdomain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-prefix