CfnAcmeDomainValidationPropsMixin

class aws_cdk.cfn_property_mixins.aws_certificatemanager.CfnAcmeDomainValidationPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::CertificateManager::AcmeDomainValidation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-acmedomainvalidation.html

CloudformationResource:

AWS::CertificateManager::AcmeDomainValidation

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.cfn_property_mixins import aws_certificatemanager as certificatemanager
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_acme_domain_validation_props_mixin = certificatemanager.CfnAcmeDomainValidationPropsMixin(certificatemanager.CfnAcmeDomainValidationMixinProps(
    acme_endpoint_arn="acmeEndpointArn",
    domain_name="domainName",
    prevalidation_options=certificatemanager.CfnAcmeDomainValidationPropsMixin.PrevalidationOptionsProperty(
        dns_prevalidation=certificatemanager.CfnAcmeDomainValidationPropsMixin.DnsPrevalidationOptionsProperty(
            domain_scope=certificatemanager.CfnAcmeDomainValidationPropsMixin.DomainScopeProperty(
                exact_domain="exactDomain",
                subdomains="subdomains",
                wildcards="wildcards"
            ),
            hosted_zone_id="hostedZoneId"
        )
    ),
    tags=[certificatemanager.CfnAcmeDomainValidationPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['acmeEndpointArn', 'domainName', 'prevalidationOptions', 'tags']

Static Methods

classmethod is_mixin(x)

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.

DnsPrevalidationOptionsProperty

class CfnAcmeDomainValidationPropsMixin.DnsPrevalidationOptionsProperty(*, domain_scope=None, hosted_zone_id=None)

Bases: object

DNS-based prevalidation options for the domain validation.

Parameters:
  • domain_scope (Union[IResolvable, DomainScopeProperty, Dict[str, Any], None]) – Controls which certificate types are authorized to be issued for the domain via the ACME endpoint.

  • hosted_zone_id (Optional[str]) – The Route 53 hosted zone ID for automatic DNS record management. When provided, the service creates the validation DNS record on the customer’s behalf.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-dnsprevalidationoptions.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.cfn_property_mixins import aws_certificatemanager as certificatemanager

dns_prevalidation_options_property = certificatemanager.CfnAcmeDomainValidationPropsMixin.DnsPrevalidationOptionsProperty(
    domain_scope=certificatemanager.CfnAcmeDomainValidationPropsMixin.DomainScopeProperty(
        exact_domain="exactDomain",
        subdomains="subdomains",
        wildcards="wildcards"
    ),
    hosted_zone_id="hostedZoneId"
)

Attributes

domain_scope

Controls which certificate types are authorized to be issued for the domain via the ACME endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-dnsprevalidationoptions.html#cfn-certificatemanager-acmedomainvalidation-dnsprevalidationoptions-domainscope

hosted_zone_id

The Route 53 hosted zone ID for automatic DNS record management.

When provided, the service creates the validation DNS record on the customer’s behalf.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-dnsprevalidationoptions.html#cfn-certificatemanager-acmedomainvalidation-dnsprevalidationoptions-hostedzoneid

DomainScopeProperty

class CfnAcmeDomainValidationPropsMixin.DomainScopeProperty(*, exact_domain=None, subdomains=None, wildcards=None)

Bases: object

Controls which certificate types are authorized to be issued for the domain via the ACME endpoint.

Parameters:
  • exact_domain (Optional[str]) – Whether certificates may be issued for the exact domain.

  • subdomains (Optional[str]) – Whether certificates may be issued for subdomains of the domain.

  • wildcards (Optional[str]) – Whether wildcard certificates may be issued for the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-domainscope.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.cfn_property_mixins import aws_certificatemanager as certificatemanager

domain_scope_property = certificatemanager.CfnAcmeDomainValidationPropsMixin.DomainScopeProperty(
    exact_domain="exactDomain",
    subdomains="subdomains",
    wildcards="wildcards"
)

Attributes

exact_domain

Whether certificates may be issued for the exact domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-domainscope.html#cfn-certificatemanager-acmedomainvalidation-domainscope-exactdomain

subdomains

Whether certificates may be issued for subdomains of the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-domainscope.html#cfn-certificatemanager-acmedomainvalidation-domainscope-subdomains

wildcards

Whether wildcard certificates may be issued for the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-domainscope.html#cfn-certificatemanager-acmedomainvalidation-domainscope-wildcards

PrevalidationOptionsProperty

class CfnAcmeDomainValidationPropsMixin.PrevalidationOptionsProperty(*, dns_prevalidation=None)

Bases: object

Prevalidation method configuration.

Currently only DNS-based prevalidation is supported.

Parameters:

dns_prevalidation (Union[IResolvable, DnsPrevalidationOptionsProperty, Dict[str, Any], None]) – DNS-based prevalidation options for the domain validation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-prevalidationoptions.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.cfn_property_mixins import aws_certificatemanager as certificatemanager

prevalidation_options_property = certificatemanager.CfnAcmeDomainValidationPropsMixin.PrevalidationOptionsProperty(
    dns_prevalidation=certificatemanager.CfnAcmeDomainValidationPropsMixin.DnsPrevalidationOptionsProperty(
        domain_scope=certificatemanager.CfnAcmeDomainValidationPropsMixin.DomainScopeProperty(
            exact_domain="exactDomain",
            subdomains="subdomains",
            wildcards="wildcards"
        ),
        hosted_zone_id="hostedZoneId"
    )
)

Attributes

dns_prevalidation

DNS-based prevalidation options for the domain validation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-prevalidationoptions.html#cfn-certificatemanager-acmedomainvalidation-prevalidationoptions-dnsprevalidation

TagsItemsProperty

class CfnAcmeDomainValidationPropsMixin.TagsItemsProperty(*, key=None, value=None)

Bases: object

Parameters:
  • key (Optional[str]) – The key name of the tag.

  • value (Optional[str]) – The value for the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-tagsitems.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.cfn_property_mixins import aws_certificatemanager as certificatemanager

tags_items_property = certificatemanager.CfnAcmeDomainValidationPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

The key name of the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-tagsitems.html#cfn-certificatemanager-acmedomainvalidation-tagsitems-key

value

The value for the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-acmedomainvalidation-tagsitems.html#cfn-certificatemanager-acmedomainvalidation-tagsitems-value