Class CfnCertificate

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCertificate

Implements

IInspectable

ICertificateRef

IConstruct

IDependable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCertificate : CfnResource, IInspectable, ICertificateRef, IConstruct, IDependable, ITaggable

Syntax (vb)

Public Class CfnCertificate Inherits CfnResource Implements IInspectable, ICertificateRef, IConstruct, IDependable, ITaggable

Remarks

You can import both the certificate and its chain in the Certificate parameter.

After importing a certificate, AWS Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::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.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)

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

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 `ACTIVE` , `PENDING_ROTATION` , or `INACTIVE` .
AttrType	If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY` .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
Certificate	The file name for the certificate.
CertificateChain	The list of certificates that make up the chain for the certificate.
CertificateRef	A reference to a Certificate resource.
CfnProperties	Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
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	Tag Manager which manages the tags for this resource.
TagsRaw	Key-value pairs that can be used to group and search for certificates.
Usage	Specifies how this certificate is used.

Methods

FromCertificateArn(Construct, string, string)	Creates a new ICertificateRef from an ARN.
FromCertificateId(Construct, string, string)	Creates a new ICertificateRef from a certificateId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

Constructors

CfnCertificate(Construct, string, ICfnCertificateProps)

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnCertificateProps: Resource properties.

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

Properties

ActiveDate

An optional date that specifies when the certificate becomes active.

public virtual string? ActiveDate { get; set; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

AttrArn

The unique Amazon Resource Name (ARN) for the certificate.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCertificateId

An array of identifiers for the imported certificates.

public virtual string AttrCertificateId { get; }

Property Value

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

string

Remarks

CloudformationAttribute: NotAfterDate

AttrNotBeforeDate

The earliest date that the certificate is valid.

public virtual string AttrNotBeforeDate { get; }

Property Value

string

Remarks

CloudformationAttribute: NotBeforeDate

AttrSerial

The serial number for the certificate.

public virtual string AttrSerial { get; }

Property Value

string

Remarks

CloudformationAttribute: Serial

AttrStatus

The certificate can be either ACTIVE , PENDING_ROTATION , or INACTIVE .

public virtual string AttrStatus { get; }

Property Value

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

string

Remarks

If there is no private key, the type is CERTIFICATE .

CloudformationAttribute: Type

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

Certificate

The file name for the certificate.

public virtual string Certificate { get; set; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

CertificateChain

The list of certificates that make up the chain for the certificate.

public virtual string? CertificateChain { get; set; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

CertificateRef

A reference to a Certificate resource.

public virtual ICertificateReference CertificateRef { get; }

Property Value

ICertificateReference

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

CfnProperties

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

Description

The name or description that's used to identity the certificate.

public virtual string? Description { get; set; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

InactiveDate

An optional date that specifies when the certificate becomes inactive.

public virtual string? InactiveDate { get; set; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

PrivateKey

The file that contains the private key for the certificate that's being imported.

public virtual string? PrivateKey { get; set; }

Property Value

string

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

TagsRaw

Key-value pairs that can be used to group and search for certificates.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

Usage

Specifies how this certificate is used.

public virtual string Usage { get; set; }

Property Value

string

Remarks

It can be used in the following ways:.

Methods

FromCertificateArn(Construct, string, string)

Creates a new ICertificateRef from an ARN.

public static ICertificateRef FromCertificateArn(Construct scope, string id, string arn)

Parameters

scope Construct
id string
arn string

Returns

ICertificateRef

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

FromCertificateId(Construct, string, string)

Creates a new ICertificateRef from a certificateId.

public static ICertificateRef FromCertificateId(Construct scope, string id, string certificateId)

Parameters

scope Construct
id string
certificateId string

Returns

ICertificateRef

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

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

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

You can import both the certificate and its chain in the Certificate parameter.

It can take up to a full day after importing a certificate for Transfer Family to emit the <code>DaysUntilExpiry</code> metric to your account. > If you use the <code>Certificate</code> parameter to upload both the certificate and its chain, don't use the <code>CertificateChain</code> parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

CloudformationResource: AWS::Transfer::Certificate

ExampleMetadata: fixture=_generated

Implements

IInspectable

ICertificateRef

Constructs.IConstruct

Constructs.IDependable

ITaggable