CertificateProps¶

class aws_cdk.aws_certificatemanager.CertificateProps(*, domain_name, subject_alternative_names=None, validation=None, validation_domains=None, validation_method=None)¶

Bases: object

Properties for your certificate.

Parameters

domain_name (str) – Fully-qualified domain name to request a certificate for. May contain wildcards, such as *.domain.com.
subject_alternative_names (Optional[Sequence[str]]) – Alternative domain names on your certificate. Use this to register alternative domain names that represent the same site. Default: - No additional FQDNs will be included as alternative domain names.
validation (Optional[CertificateValidation]) – How to validate this certificate. Default: CertificateValidation.fromEmail()
validation_domains (Optional[Mapping[str, str]]) – (deprecated) What validation domain to use for every requested domain. Has to be a superdomain of the requested domain. Default: - Apex domain is used for every domain that’s not overridden.
validation_method (Optional[ValidationMethod]) – (deprecated) Validation method used to assert domain ownership. Default: ValidationMethod.EMAIL

ExampleMetadata

infused

Example:

import aws_cdk.aws_cloudwatch as cloudwatch

# my_hosted_zone: route53.HostedZone

certificate = acm.Certificate(self, "Certificate",
    domain_name="hello.example.com",
    validation=acm.CertificateValidation.from_dns(my_hosted_zone)
)
certificate.metric_days_to_expiry().create_alarm(self, "Alarm",
    comparison_operator=cloudwatch.ComparisonOperator.LESS_THAN_THRESHOLD,
    evaluation_periods=1,
    threshold=45
)

Attributes

domain_name¶

Fully-qualified domain name to request a certificate for.

May contain wildcards, such as *.domain.com.

Return type: str

subject_alternative_names¶

Alternative domain names on your certificate.

Use this to register alternative domain names that represent the same site.

Default

No additional FQDNs will be included as alternative domain names.

Return type

Optional[List[str]]

validation¶

How to validate this certificate.

Default: CertificateValidation.fromEmail()
Return type: Optional[CertificateValidation]

validation_domains¶

(deprecated) What validation domain to use for every requested domain.

Has to be a superdomain of the requested domain.

Default

Apex domain is used for every domain that’s not overridden.

Deprecated

use validation instead.

Stability

deprecated

Return type

Optional[Mapping[str, str]]

validation_method¶

(deprecated) Validation method used to assert domain ownership.

Default: ValidationMethod.EMAIL
Deprecated: use validation instead.
Stability: deprecated
Return type: Optional[ValidationMethod]