CfnCertificatePropsMixin

class aws_cdk.mixins_preview.aws_certificatemanager.mixins.CfnCertificatePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::CertificateManager::Certificate resource requests an Certificate Manager ( ACM ) certificate that you can use to enable secure connections.

For example, you can deploy an ACM certificate to an Elastic Load Balancer to enable HTTPS support. For more information, see RequestCertificate in the Certificate Manager API Reference. .. epigraph:

When you use the ``AWS::CertificateManager::Certificate`` resource in a CloudFormation stack, domain validation is handled automatically if all three of the following are true: The certificate domain is hosted in Amazon Route 53, the domain resides in your AWS account , and you are using DNS validation.

However, if the certificate uses email validation, or if the domain is not hosted in Route 53, then the stack will remain in the ``CREATE_IN_PROGRESS`` state. Further stack operations are delayed until you validate the certificate request, either by acting upon the instructions in the validation email, or by adding a CNAME record to your DNS configuration. For more information, see `Option 1: DNS Validation <https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html>`_ and `Option 2: Email Validation <https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html>`_ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html
CloudformationResource:: AWS::CertificateManager::Certificate
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_certificatemanager import mixins as certificatemanager_mixins

cfn_certificate_props_mixin = certificatemanager_mixins.CfnCertificatePropsMixin(certificatemanager_mixins.CfnCertificateMixinProps(
    certificate_authority_arn="certificateAuthorityArn",
    certificate_export="certificateExport",
    certificate_transparency_logging_preference="certificateTransparencyLoggingPreference",
    domain_name="domainName",
    domain_validation_options=[certificatemanager_mixins.CfnCertificatePropsMixin.DomainValidationOptionProperty(
        domain_name="domainName",
        hosted_zone_id="hostedZoneId",
        validation_domain="validationDomain"
    )],
    key_algorithm="keyAlgorithm",
    subject_alternative_names=["subjectAlternativeNames"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    validation_method="validationMethod"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CertificateManager::Certificate.

Parameters:

props (Union[CfnCertificateMixinProps, 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 = ['certificateAuthorityArn', 'certificateExport', 'certificateTransparencyLoggingPreference', 'domainName', 'domainValidationOptions', 'keyAlgorithm', 'subjectAlternativeNames', 'tags', 'validationMethod']

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

DomainValidationOptionProperty

class CfnCertificatePropsMixin.DomainValidationOptionProperty(*, domain_name=None, hosted_zone_id=None, validation_domain=None)

Bases: object

DomainValidationOption is a property of the AWS::CertificateManager::Certificate resource that specifies the Certificate Manager ( ACM ) certificate domain to validate. Depending on the chosen validation method, ACM checks the domain’s DNS record for a validation CNAME, or it attempts to send a validation email message to the domain owner.

Parameters:

domain_name (Optional[str]) – A fully qualified domain name (FQDN) in the certificate request.
hosted_zone_id (Optional[str]) – The HostedZoneId option, which is available if you are using Route 53 as your domain registrar, causes ACM to add your CNAME to the domain record. Your list of DomainValidationOptions must contain one and only one of the domain-validation options, and the HostedZoneId can be used only when DNS is specified as your validation method. Use the Route 53 ListHostedZones API to discover IDs for available hosted zones. This option is required for publicly trusted certificates. .. epigraph:: The ListHostedZones API returns IDs in the format “/hostedzone/Z111111QQQQQQQ”, but CloudFormation requires the IDs to be in the format “Z111111QQQQQQQ”. When you change your DomainValidationOptions , a new resource is created.
validation_domain (Optional[str]) – The domain name to which you want ACM to send validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com , you can specify example.com as this value. In that case, ACM sends domain validation emails to the following five addresses: - admin@example.com - administrator@example.com - hostmaster@example.com - postmaster@example.com - webmaster@example.com

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.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_certificatemanager import mixins as certificatemanager_mixins

domain_validation_option_property = certificatemanager_mixins.CfnCertificatePropsMixin.DomainValidationOptionProperty(
    domain_name="domainName",
    hosted_zone_id="hostedZoneId",
    validation_domain="validationDomain"
)

Attributes

domain_name

A fully qualified domain name (FQDN) in the certificate request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-domainname

hosted_zone_id

The HostedZoneId option, which is available if you are using Route 53 as your domain registrar, causes ACM to add your CNAME to the domain record.

Your list of DomainValidationOptions must contain one and only one of the domain-validation options, and the HostedZoneId can be used only when DNS is specified as your validation method.

Use the Route 53 ListHostedZones API to discover IDs for available hosted zones.

This option is required for publicly trusted certificates. .. epigraph:

The ``ListHostedZones`` API returns IDs in the format "/hostedzone/Z111111QQQQQQQ", but CloudFormation requires the IDs to be in the format "Z111111QQQQQQQ".

When you change your DomainValidationOptions , a new resource is created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-hostedzoneid

validation_domain

The domain name to which you want ACM to send validation emails.

This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com , you can specify example.com as this value. In that case, ACM sends domain validation emails to the following five addresses:

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-validationdomain