@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-20T22:19:55.003Z") public class CfnCertificate extends CfnResource implements IInspectable
Use the AWS::IoT::Certificate
resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see X.509 Client Certificates in the AWS IoT Developer Guide .
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.iot.*; CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate") .status("status") // the properties below are optional .caCertificatePem("caCertificatePem") .certificateMode("certificateMode") .certificatePem("certificatePem") .certificateSigningRequest("certificateSigningRequest") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnCertificate.Builder
A fluent builder for
CfnCertificate . |
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::IoT::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 |
getAttrArn()
Returns the Amazon Resource Name (ARN) for the instance profile.
|
java.lang.String |
getAttrId()
The certificate ID.
|
java.lang.String |
getCaCertificatePem()
The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
|
java.lang.String |
getCertificateMode()
Specifies which mode of certificate registration to use with this resource.
|
java.lang.String |
getCertificatePem()
The certificate data in PEM format.
|
java.lang.String |
getCertificateSigningRequest()
The certificate signing request (CSR).
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getStatus()
The status of the 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 |
setCaCertificatePem(java.lang.String value)
The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
|
void |
setCertificateMode(java.lang.String value)
Specifies which mode of certificate registration to use with this resource.
|
void |
setCertificatePem(java.lang.String value)
The certificate data in PEM format.
|
void |
setCertificateSigningRequest(java.lang.String value)
The certificate signing request (CSR).
|
void |
setStatus(java.lang.String value)
The status of the 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.public java.lang.String getAttrArn()
{ "Fn::GetAtt": ["MyCertificate", "Arn"] }
A value similar to the following is returned:
arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2
public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getStatus()
Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.
The status value REGISTER_INACTIVE is deprecated and should not be used.
public void setStatus(java.lang.String value)
Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.
The status value REGISTER_INACTIVE is deprecated and should not be used.
public java.lang.String getCaCertificatePem()
public void setCaCertificatePem(java.lang.String value)
public java.lang.String getCertificateMode()
Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.
public void setCertificateMode(java.lang.String value)
Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.
public java.lang.String getCertificatePem()
Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.
public void setCertificatePem(java.lang.String value)
Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.
public java.lang.String getCertificateSigningRequest()
public void setCertificateSigningRequest(java.lang.String value)