Class CfnCACertificate
Specifies a CA certificate.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCACertificate : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCACertificate Inherits CfnResource Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
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) | Specifies a CA certificate. |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CaCertificatePem | The certificate data in PEM format. |
CertificateMode | The mode of the CA. |
CfnProperties | Specifies a CA certificate. |
RegistrationConfig | Information about the registration configuration. |
RemoveAutoRegistration | If true, removes auto registration. |
Status | The status of the CA certificate. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | 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>) | Specifies a CA certificate. |
Constructors
CfnCACertificate(Construct, string, ICfnCACertificateProps)
Specifies a CA certificate.
public CfnCACertificate(Construct scope, string id, ICfnCACertificateProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnCACertificateProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the CA certificate. For example:.
public virtual string AttrArn { get; }
Property Value
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
Remarks
CloudformationAttribute: Id
AutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates.
public virtual string? AutoRegistrationStatus { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
CaCertificatePem
The certificate data in PEM format.
public virtual string CaCertificatePem { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
CertificateMode
The mode of the CA.
public virtual string? CertificateMode { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
CfnProperties
Specifies a CA certificate.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
RegistrationConfig
Information about the registration configuration.
public virtual object? RegistrationConfig { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
RemoveAutoRegistration
If true, removes auto registration.
public virtual object? RemoveAutoRegistration { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
Status
The status of the CA certificate.
public virtual string Status { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
VerificationCertificatePem
The private key verification certificate.
public virtual string? VerificationCertificatePem { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
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.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Specifies a CA certificate.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-cacertificate.html
CloudformationResource: AWS::IoT::CACertificate
ExampleMetadata: fixture=_generated