software.amazon.awscdk.services.iot

Class CfnCertificate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnCertificate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.852Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCertificate(software.constructs.Construct scope, 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
String	getAttrArn() Returns the Amazon Resource Name (ARN) for the instance profile.
String	getAttrId() The certificate ID.
String	getCaCertificatePem() The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
String	getCertificateMode() Specifies which mode of certificate registration to use with this resource.
String	getCertificatePem() The certificate data in PEM format.
String	getCertificateSigningRequest() The certificate signing request (CSR).
protected Map<String,Object>	getCfnProperties()
String	getStatus() The status of the certificate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCaCertificatePem(String value) The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
void	setCertificateMode(String value) Specifies which mode of certificate registration to use with this resource.
void	setCertificatePem(String value) The certificate data in PEM format.
void	setCertificateSigningRequest(String value) The certificate signing request (CSR).
void	setStatus(String value) The status of the certificate.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnCertificate(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The certificate ID.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getStatus

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setStatus(@NotNull
                                               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

@Stability(value=Stable)
 @Nullable
public String getCaCertificatePem()

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

setCaCertificatePem

@Stability(value=Stable)
public void setCaCertificatePem(@Nullable
                                                         String value)

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

getCertificateMode

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setCertificateMode(@Nullable
                                                        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

@Stability(value=Stable)
 @Nullable
public String getCertificatePem()

The certificate data in PEM format.

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

setCertificatePem

@Stability(value=Stable)
public void setCertificatePem(@Nullable
                                                       String value)

The certificate data in PEM format.

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

getCertificateSigningRequest

@Stability(value=Stable)
 @Nullable
public String getCertificateSigningRequest()

The certificate signing request (CSR).

setCertificateSigningRequest

@Stability(value=Stable)
public void setCertificateSigningRequest(@Nullable
                                                                  String value)

The certificate signing request (CSR).