@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:46.084Z") public class CfnCertificate extends CfnResource implements IInspectable
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.
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 and Option 2: Email Validation .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.certificatemanager.*; CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate") .domainName("domainName") // the properties below are optional .certificateAuthorityArn("certificateAuthorityArn") .certificateTransparencyLoggingPreference("certificateTransparencyLoggingPreference") .domainValidationOptions(List.of(DomainValidationOptionProperty.builder() .domainName("domainName") // the properties below are optional .hostedZoneId("hostedZoneId") .validationDomain("validationDomain") .build())) .subjectAlternativeNames(List.of("subjectAlternativeNames")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .validationMethod("validationMethod") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnCertificate.Builder
A fluent builder for
CfnCertificate . |
static interface |
CfnCertificate.DomainValidationOptionProperty
`DomainValidationOption` is a property of the [AWS::CertificateManager::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html) resource that specifies the AWS Certificate Manager ( ACM ) certificate domain to validate.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCertificate(Construct scope,
java.lang.String id,
CfnCertificateProps props)
Create a new `AWS::CertificateManager::Certificate`.
|
protected |
CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCertificateAuthorityArn()
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
|
java.lang.String |
getCertificateTransparencyLoggingPreference()
You can opt out of certificate transparency logging by specifying the `DISABLED` option.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomainName()
The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate.
|
java.lang.Object |
getDomainValidationOptions()
Domain information that domain name registrars use to verify your identity.
|
java.util.List<java.lang.String> |
getSubjectAlternativeNames()
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
|
TagManager |
getTags()
Key-value pairs that can identify the certificate.
|
java.lang.String |
getValidationMethod()
The method you want to use to validate that you own or control the domain associated with a public certificate.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCertificateAuthorityArn(java.lang.String value)
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
|
void |
setCertificateTransparencyLoggingPreference(java.lang.String value)
You can opt out of certificate transparency logging by specifying the `DISABLED` option.
|
void |
setDomainName(java.lang.String value)
The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate.
|
void |
setDomainValidationOptions(IResolvable value)
Domain information that domain name registrars use to verify your identity.
|
void |
setDomainValidationOptions(java.util.List<java.lang.Object> value)
Domain information that domain name registrars use to verify your identity.
|
void |
setSubjectAlternativeNames(java.util.List<java.lang.String> value)
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
|
void |
setValidationMethod(java.lang.String value)
The method you want to use to validate that you own or control the domain associated with a public certificate.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCertificate(Construct scope, java.lang.String id, CfnCertificateProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getDomainName()
public void setDomainName(java.lang.String value)
public java.lang.String getCertificateAuthorityArn()
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
public void setCertificateAuthorityArn(java.lang.String value)
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
public java.lang.String getCertificateTransparencyLoggingPreference()
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.
public void setCertificateTransparencyLoggingPreference(java.lang.String value)
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.
public java.lang.Object getDomainValidationOptions()
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.
public void setDomainValidationOptions(IResolvable value)
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.
public void setDomainValidationOptions(java.util.List<java.lang.Object> value)
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.
public java.util.List<java.lang.String> getSubjectAlternativeNames()
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.
public void setSubjectAlternativeNames(java.util.List<java.lang.String> value)
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.
public java.lang.String getValidationMethod()
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.
public void setValidationMethod(java.lang.String value)
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.