Class CfnCertificate
A CloudFormation AWS::Transfer::Certificate
.
Inherited Members
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.AWS.Transfer.dll
Syntax (csharp)
public class CfnCertificate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCertificate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
CloudformationResource: AWS::Transfer::Certificate
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.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.Transfer;
var cfnCertificate = new CfnCertificate(this, "MyCfnCertificate", new CfnCertificateProps {
Certificate = "certificate",
Usage = "usage",
// the properties below are optional
ActiveDate = "activeDate",
CertificateChain = "certificateChain",
Description = "description",
InactiveDate = "inactiveDate",
PrivateKey = "privateKey",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCertificate(Construct, String, ICfnCertificateProps) | Create a new |
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 |
Properties
ActiveDate | An optional date that specifies when the certificate becomes active. |
AttrArn | The unique Amazon Resource Name (ARN) for the certificate. |
AttrCertificateId | An array of identifiers for the imported certificates. |
AttrNotAfterDate | The final date that the certificate is valid. |
AttrNotBeforeDate | The earliest date that the certificate is valid. |
AttrSerial | The serial number for the certificate. |
AttrStatus | The certificate can be either |
AttrType | If a private key has been specified for the certificate, its type is |
Certificate | The file name for the certificate. |
CertificateChain | The list of certificates that make up the chain for the certificate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The name or description that's used to identity the certificate. |
InactiveDate | An optional date that specifies when the certificate becomes inactive. |
PrivateKey | The file that contains the private key for the certificate that's being imported. |
Tags | Key-value pairs that can be used to group and search for certificates. |
Usage | Specifies whether this certificate is used for signing or encryption. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCertificate(Construct, String, ICfnCertificateProps)
Create a new AWS::Transfer::Certificate
.
public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCertificateProps
- resource properties.
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
Properties
ActiveDate
An optional date that specifies when the certificate becomes active.
public virtual string ActiveDate { get; set; }
Property Value
System.String
Remarks
AttrArn
The unique Amazon Resource Name (ARN) for the certificate.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCertificateId
An array of identifiers for the imported certificates.
public virtual string AttrCertificateId { get; }
Property Value
System.String
Remarks
You use this identifier for working with profiles and partner profiles.
CloudformationAttribute: CertificateId
AttrNotAfterDate
The final date that the certificate is valid.
public virtual string AttrNotAfterDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NotAfterDate
AttrNotBeforeDate
The earliest date that the certificate is valid.
public virtual string AttrNotBeforeDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NotBeforeDate
AttrSerial
The serial number for the certificate.
public virtual string AttrSerial { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Serial
AttrStatus
The certificate can be either ACTIVE
, PENDING_ROTATION
, or INACTIVE
.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
PENDING_ROTATION
means that this certificate will replace the current certificate when it expires.
CloudformationAttribute: Status
AttrType
If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY
.
public virtual string AttrType { get; }
Property Value
System.String
Remarks
If there is no private key, the type is CERTIFICATE
.
CloudformationAttribute: Type
Certificate
The file name for the certificate.
public virtual string Certificate { get; set; }
Property Value
System.String
Remarks
CertificateChain
The list of certificates that make up the chain for the certificate.
public virtual string CertificateChain { get; set; }
Property Value
System.String
Remarks
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
Description
The name or description that's used to identity the certificate.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
InactiveDate
An optional date that specifies when the certificate becomes inactive.
public virtual string InactiveDate { get; set; }
Property Value
System.String
Remarks
PrivateKey
The file that contains the private key for the certificate that's being imported.
public virtual string PrivateKey { get; set; }
Property Value
System.String
Remarks
Tags
Key-value pairs that can be used to group and search for certificates.
public virtual TagManager Tags { get; }
Property Value
Remarks
Usage
Specifies whether this certificate is used for signing or encryption.
public virtual string Usage { 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>