CfnCertificateProps

class aws_cdk.aws_certificatemanager.CfnCertificateProps(*, domain_name, certificate_authority_arn=None, certificate_transparency_logging_preference=None, domain_validation_options=None, subject_alternative_names=None, tags=None, validation_method=None)

Bases: object

Properties for defining a CfnCertificate.

Parameters
  • domain_name (str) – The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com , site.example.com , and images.example.com..

  • certificate_authority_arn (Optional[str]) – The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

  • certificate_transparency_logging_preference (Optional[str]) – You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED . If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference. Changing the certificate transparency logging preference will update the existing resource by calling UpdateCertificateOptions on the certificate. This action will not create a new resource.

  • domain_validation_options (Union[IResolvable, Sequence[Union[IResolvable, DomainValidationOptionProperty]], None]) – Domain information that domain name registrars use to verify your identity. .. epigraph:: In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the DomainName property needs to be identical to one of the DomainName property supplied in DomainValidationOptions, if the ValidationMethod is DNS. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.

  • subject_alternative_names (Optional[Sequence[str]]) – Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.

  • tags (Optional[Sequence[CfnTag]]) – Key-value pairs that can identify the certificate.

  • validation_method (Optional[str]) – The method you want to use to validate that you own or control the domain associated with a public certificate. You can validate with DNS or validate with email . We recommend that you use DNS validation. If not specified, this property defaults to email validation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-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.
import aws_cdk.aws_certificatemanager as certificatemanager

cfn_certificate_props = certificatemanager.CfnCertificateProps(
    domain_name="domainName",

    # the properties below are optional
    certificate_authority_arn="certificateAuthorityArn",
    certificate_transparency_logging_preference="certificateTransparencyLoggingPreference",
    domain_validation_options=[certificatemanager.CfnCertificate.DomainValidationOptionProperty(
        domain_name="domainName",

        # the properties below are optional
        hosted_zone_id="hostedZoneId",
        validation_domain="validationDomain"
    )],
    subject_alternative_names=["subjectAlternativeNames"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    validation_method="validationMethod"
)

Attributes

certificate_authority_arn

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.

If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Link

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

Return type

Optional[str]

certificate_transparency_logging_preference

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .

If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference.

Changing the certificate transparency logging preference will update the existing resource by calling UpdateCertificateOptions on the certificate. This action will not create a new resource.

Link

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

Return type

Optional[str]

domain_name

The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com , site.example.com , and images.example.com..

Link

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

Return type

str

domain_validation_options

Domain information that domain name registrars use to verify your identity.

In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the DomainName property needs to be identical to one of the DomainName property supplied in DomainValidationOptions, if the ValidationMethod is DNS. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DomainValidationOptionProperty]], None]

subject_alternative_names

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.

For example, you can add www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.

Link

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

Return type

Optional[List[str]]

tags

Key-value pairs that can identify the certificate.

Link

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

Return type

Optional[List[CfnTag]]

validation_method

The method you want to use to validate that you own or control the domain associated with a public certificate.

You can validate with DNS or validate with email . We recommend that you use DNS validation.

If not specified, this property defaults to email validation.

Link

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

Return type

Optional[str]