software.amazon.awscdk.services.iot

Class CfnCertificate

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iot.CfnCertificate

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:15.491Z")
public class CfnCertificate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::Certificate`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCertificate.Builder A fluent builder for CfnCertificate.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCertificate

protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

CfnCertificate

protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCertificate

public CfnCertificate(Construct scope,
                      java.lang.String id,
                      CfnCertificateProps props)

Create a new `AWS::IoT::Certificate`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

Returns the Amazon Resource Name (ARN) for the instance profile. For example:.

{ "Fn::GetAtt": ["MyCertificate", "Arn"] }

A value similar to the following is returned:

arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

getAttrId

public java.lang.String getAttrId()

The certificate ID.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getStatus

public java.lang.String getStatus()

The status of the certificate.

Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

The status value REGISTER_INACTIVE is deprecated and should not be used.

setStatus

public void setStatus(java.lang.String value)

The status of the certificate.

Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

The status value REGISTER_INACTIVE is deprecated and should not be used.

getCaCertificatePem

public java.lang.String getCaCertificatePem()

The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.

setCaCertificatePem

public void setCaCertificatePem(java.lang.String value)

The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.

getCertificateMode

public java.lang.String getCertificateMode()

Specifies which mode of certificate registration to use with this resource.

Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.

setCertificateMode

public void setCertificateMode(java.lang.String value)

Specifies which mode of certificate registration to use with this resource.

Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.

getCertificatePem

public java.lang.String getCertificatePem()

The certificate data in PEM format.

Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.

setCertificatePem

public void setCertificatePem(java.lang.String value)

The certificate data in PEM format.

Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.

getCertificateSigningRequest

public java.lang.String getCertificateSigningRequest()

The certificate signing request (CSR).

setCertificateSigningRequest

public void setCertificateSigningRequest(java.lang.String value)

The certificate signing request (CSR).