Class CfnCertificate
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 .
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCertificate : CfnResource, IInspectable
Syntax (vb)
Public Class CfnCertificate
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html
CloudformationResource: AWS::IoT::Certificate
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 cfnCertificate = new CfnCertificate(this, "MyCfnCertificate", new CfnCertificateProps {
Status = "status",
// the properties below are optional
CaCertificatePem = "caCertificatePem",
CertificateMode = "certificateMode",
CertificatePem = "certificatePem",
CertificateSigningRequest = "certificateSigningRequest"
});
Synopsis
Constructors
CfnCertificate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCertificate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCertificate(Construct, String, ICfnCertificateProps) |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) for the certificate. For example:. |
AttrId | The certificate ID. |
CaCertificatePem | The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY. |
CertificateMode | Specifies which mode of certificate registration to use with this resource. |
CertificatePem | The certificate data in PEM format. |
CertificateSigningRequest | The certificate signing request (CSR). |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Status | The status of the certificate. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCertificate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCertificate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCertificate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCertificate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCertificate(Construct, String, ICfnCertificateProps)
public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnCertificateProps
Resource properties.
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the certificate. For example:.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
{ "Fn::GetAtt": ["MyCertificate", "Arn"] }
A value similar to the following is returned:
arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2
CloudformationAttribute: Arn
AttrId
The certificate ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CaCertificatePem
The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
public virtual string CaCertificatePem { get; set; }
Property Value
System.String
CertificateMode
Specifies which mode of certificate registration to use with this resource.
public virtual string CertificateMode { get; set; }
Property Value
System.String
CertificatePem
The certificate data in PEM format.
public virtual string CertificatePem { get; set; }
Property Value
System.String
CertificateSigningRequest
The certificate signing request (CSR).
public virtual string CertificateSigningRequest { get; set; }
Property Value
System.String
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
Status
The status of the certificate.
public virtual string Status { get; set; }
Property Value
System.String
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>