Class CfnCACertificate
A CloudFormation AWS::IoT::CACertificate
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnCACertificate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCACertificate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a CA certificate.
CloudformationResource: AWS::IoT::CACertificate
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnCACertificate = new CfnCACertificate(this, "MyCfnCACertificate", new CfnCACertificateProps {
CaCertificatePem = "caCertificatePem",
Status = "status",
// the properties below are optional
AutoRegistrationStatus = "autoRegistrationStatus",
CertificateMode = "certificateMode",
RegistrationConfig = new RegistrationConfigProperty {
RoleArn = "roleArn",
TemplateBody = "templateBody",
TemplateName = "templateName"
},
RemoveAutoRegistration = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VerificationCertificatePem = "verificationCertificatePem"
});
Synopsis
Constructors
CfnCACertificate(Construct, String, ICfnCACertificateProps) | Create a new |
CfnCACertificate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCACertificate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) for the CA certificate. For example:. |
AttrId | The CA certificate ID. |
AutoRegistrationStatus | Whether the CA certificate is configured for auto registration of device certificates. |
CaCertificatePem | The certificate data in PEM format. |
CertificateMode | The mode of the CA. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
RegistrationConfig | Information about the registration configuration. |
RemoveAutoRegistration | If true, removes auto registration. |
Status | The status of the CA certificate. |
Tags | An array of key-value pairs to apply to this resource. |
VerificationCertificatePem | The private key verification certificate. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCACertificate(Construct, String, ICfnCACertificateProps)
Create a new AWS::IoT::CACertificate
.
public CfnCACertificate(Construct scope, string id, ICfnCACertificateProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCACertificateProps
- resource properties.
CfnCACertificate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCACertificate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCACertificate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCACertificate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the CA certificate. For example:.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
{ "Fn::GetAtt": ["MyCACertificate", "Arn"] }
A value similar to the following is returned:
arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5
CloudformationAttribute: Arn
AttrId
The CA certificate ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates.
public virtual string AutoRegistrationStatus { get; set; }
Property Value
System.String
Remarks
Valid values are "ENABLE" and "DISABLE".
CaCertificatePem
The certificate data in PEM format.
public virtual string CaCertificatePem { get; set; }
Property Value
System.String
Remarks
CertificateMode
The mode of the CA.
public virtual string CertificateMode { get; set; }
Property Value
System.String
Remarks
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".
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
RegistrationConfig
Information about the registration configuration.
public virtual object RegistrationConfig { get; set; }
Property Value
System.Object
Remarks
RemoveAutoRegistration
If true, removes auto registration.
public virtual object RemoveAutoRegistration { get; set; }
Property Value
System.Object
Remarks
Status
The status of the CA certificate.
public virtual string Status { get; set; }
Property Value
System.String
Remarks
Valid values are "ACTIVE" and "INACTIVE".
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
VerificationCertificatePem
The private key verification certificate.
public virtual string VerificationCertificatePem { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>