@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.782Z") public class CfnCACertificate extends CfnResource implements IInspectable
Specifies a CA certificate.
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.*; CfnCACertificate cfnCACertificate = CfnCACertificate.Builder.create(this, "MyCfnCACertificate") .caCertificatePem("caCertificatePem") .status("status") // the properties below are optional .autoRegistrationStatus("autoRegistrationStatus") .certificateMode("certificateMode") .registrationConfig(RegistrationConfigProperty.builder() .roleArn("roleArn") .templateBody("templateBody") .templateName("templateName") .build()) .removeAutoRegistration(false) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .verificationCertificatePem("verificationCertificatePem") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnCACertificate.Builder
A fluent builder for
CfnCACertificate . |
static interface |
CfnCACertificate.RegistrationConfigProperty
The registration configuration.
|
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 |
---|---|
|
CfnCACertificate(Construct scope,
java.lang.String id,
CfnCACertificateProps props)
Create a new `AWS::IoT::CACertificate`.
|
protected |
CfnCACertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnCACertificate(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
Returns the Amazon Resource Name (ARN) for the CA certificate.
|
java.lang.String |
getAttrId()
The CA certificate ID.
|
java.lang.String |
getAutoRegistrationStatus()
Whether the CA certificate is configured for auto registration of device certificates.
|
java.lang.String |
getCaCertificatePem()
The certificate data in PEM format.
|
java.lang.String |
getCertificateMode()
The mode of the CA.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getRegistrationConfig()
Information about the registration configuration.
|
java.lang.Object |
getRemoveAutoRegistration()
If true, removes auto registration.
|
java.lang.String |
getStatus()
The status of the CA certificate.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getVerificationCertificatePem()
The private key verification 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 |
setAutoRegistrationStatus(java.lang.String value)
Whether the CA certificate is configured for auto registration of device certificates.
|
void |
setCaCertificatePem(java.lang.String value)
The certificate data in PEM format.
|
void |
setCertificateMode(java.lang.String value)
The mode of the CA.
|
void |
setRegistrationConfig(CfnCACertificate.RegistrationConfigProperty value)
Information about the registration configuration.
|
void |
setRegistrationConfig(IResolvable value)
Information about the registration configuration.
|
void |
setRemoveAutoRegistration(java.lang.Boolean value)
If true, removes auto registration.
|
void |
setRemoveAutoRegistration(IResolvable value)
If true, removes auto registration.
|
void |
setStatus(java.lang.String value)
The status of the CA certificate.
|
void |
setVerificationCertificatePem(java.lang.String value)
The private key verification 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 CfnCACertificate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCACertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCACertificate(Construct scope, java.lang.String id, CfnCACertificateProps 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": ["MyCACertificate", "Arn"] }
A value similar to the following is returned:
arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5
public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getCaCertificatePem()
public void setCaCertificatePem(java.lang.String value)
public java.lang.String getStatus()
Valid values are "ACTIVE" and "INACTIVE".
public void setStatus(java.lang.String value)
Valid values are "ACTIVE" and "INACTIVE".
public java.lang.String getAutoRegistrationStatus()
Valid values are "ENABLE" and "DISABLE".
public void setAutoRegistrationStatus(java.lang.String value)
Valid values are "ENABLE" and "DISABLE".
public java.lang.String getCertificateMode()
All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .
Valid values are "DEFAULT" and "SNI_ONLY".
public void setCertificateMode(java.lang.String value)
All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .
Valid values are "DEFAULT" and "SNI_ONLY".
public java.lang.Object getRegistrationConfig()
public void setRegistrationConfig(IResolvable value)
public void setRegistrationConfig(CfnCACertificate.RegistrationConfigProperty value)
public java.lang.Object getRemoveAutoRegistration()
public void setRemoveAutoRegistration(java.lang.Boolean value)
public void setRemoveAutoRegistration(IResolvable value)
public java.lang.String getVerificationCertificatePem()
public void setVerificationCertificatePem(java.lang.String value)