CfnCertificate
- class aws_cdk.aws_certificatemanager.CfnCertificate(scope, id, *, 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:
CfnResource
A CloudFormation
AWS::CertificateManager::Certificate
.The
AWS::CertificateManager::Certificate
resource requests an AWS 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 AWS 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>`_ .
- CloudformationResource:
AWS::CertificateManager::Certificate
- Link:
- 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 = certificatemanager.CfnCertificate(self, "MyCfnCertificate", 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" )
Create a new
AWS::CertificateManager::Certificate
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
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
protectswww.example.com
,site.example.com
, andimages.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 Private Certificate Authority 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 theDISABLED
option. Opt in by specifyingENABLED
. 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 callingUpdateCertificateOptions
on the certificate. This action will not create a new resource.domain_validation_options (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DomainValidationOptionProperty
,Dict
[str
,Any
]]],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, theDomainName
property needs to be identical to one of theDomainName
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 theDomainName
field is www.example.com if users can reach your site by using either name.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
)value (
Any
)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CertificateManager::Certificate'
- 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 Private Certificate Authority 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
You can opt out of certificate transparency logging by specifying the
DISABLED
option. Opt in by specifyingENABLED
.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.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- 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
protectswww.example.com
,site.example.com
, andimages.example.com.
.
- 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 theDomainName
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.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- 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.
- tags
Key-value pairs that can identify the certificate.
- 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.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
)- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
DomainValidationOptionProperty
- class CfnCertificate.DomainValidationOptionProperty(*, domain_name, hosted_zone_id=None, validation_domain=None)
Bases:
object
DomainValidationOption
is a property of the AWS::CertificateManager::Certificate resource that specifies the AWS 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 (
str
) – A fully qualified domain name (FQDN) in the certificate request.hosted_zone_id (
Optional
[str
]) – TheHostedZoneId
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 ofDomainValidationOptions
must contain one and only one of the domain-validation options, and theHostedZoneId
can be used only whenDNS
is specified as your validation method. Use the Route 53ListHostedZones
API to discover IDs for available hosted zones. This option is required for publicly trusted certificates. .. epigraph:: TheListHostedZones
API returns IDs in the format “/hostedzone/Z111111QQQQQQQ”, but CloudFormation requires the IDs to be in the format “Z111111QQQQQQQ”. When you change yourDomainValidationOptions
, 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 theDomainName
value or a superdomain of theDomainName
value. For example, if you request a certificate fortesting.example.com
, you can specifyexample.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
- Link:
- 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 domain_validation_option_property = certificatemanager.CfnCertificate.DomainValidationOptionProperty( domain_name="domainName", # the properties below are optional hosted_zone_id="hostedZoneId", validation_domain="validationDomain" )
Attributes
- domain_name
A fully qualified domain name (FQDN) in the certificate request.
- 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 theHostedZoneId
can be used only whenDNS
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
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 theDomainName
value. For example, if you request a certificate fortesting.example.com
, you can specifyexample.com
as this value. In that case, ACM sends domain validation emails to the following five addresses: