class CfnCertificate (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Transfer.CfnCertificate`
Java	`software.amazon.awscdk.services.transfer.CfnCertificate`
Python	`aws_cdk.aws_transfer.CfnCertificate`
TypeScript	`@aws-cdk/aws-transfer` » `CfnCertificate`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Transfer::Certificate.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as transfer from '@aws-cdk/aws-transfer';
const cfnCertificate = new transfer.CfnCertificate(this, 'MyCfnCertificate', {
  certificate: 'certificate',
  usage: 'usage',

  // the properties below are optional
  activeDate: 'activeDate',
  certificateChain: 'certificateChain',
  description: 'description',
  inactiveDate: 'inactiveDate',
  privateKey: 'privateKey',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnCertificate(scope: Construct, id: string, props: CfnCertificateProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnCertificateProps — - resource properties.

Create a new AWS::Transfer::Certificate.

Construct Props

Name	Type	Description
certificate	`string`	The file name for the certificate.
usage	`string`	Specifies whether this certificate is used for signing or encryption.
activeDate?	`string`	An optional date that specifies when the certificate becomes active.
certificateChain?	`string`	The list of certificates that make up the chain for the certificate.
description?	`string`	The name or description that's used to identity the certificate.
inactiveDate?	`string`	An optional date that specifies when the certificate becomes inactive.
privateKey?	`string`	The file that contains the private key for the certificate that's being imported.
tags?	`CfnTag[]`	Key-value pairs that can be used to group and search for certificates.

certificate

Type: string

The file name for the certificate.

usage

Type: string

Specifies whether this certificate is used for signing or encryption.

activeDate?

Type: string (optional)

An optional date that specifies when the certificate becomes active.

certificateChain?

Type: string (optional)

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

description?

Type: string (optional)

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

inactiveDate?

Type: string (optional)

An optional date that specifies when the certificate becomes inactive.

privateKey?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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

Properties

Name	Type	Description
attrArn	`string`	The unique Amazon Resource Name (ARN) for the certificate.
attrCertificateId	`string`	An array of identifiers for the imported certificates.
attrNotAfterDate	`string`	The final date that the certificate is valid.
attrNotBeforeDate	`string`	The earliest date that the certificate is valid.
attrSerial	`string`	The serial number for the certificate.
attrStatus	`string`	The certificate can be either `ACTIVE` , `PENDING_ROTATION` , or `INACTIVE` .
attrType	`string`	If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY` .
certificate	`string`	The file name for the certificate.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Key-value pairs that can be used to group and search for certificates.
usage	`string`	Specifies whether this certificate is used for signing or encryption.
activeDate?	`string`	An optional date that specifies when the certificate becomes active.
certificateChain?	`string`	The list of certificates that make up the chain for the certificate.
description?	`string`	The name or description that's used to identity the certificate.
inactiveDate?	`string`	An optional date that specifies when the certificate becomes inactive.
privateKey?	`string`	The file that contains the private key for the certificate that's being imported.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

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

attrCertificateId

Type: string

An array of identifiers for the imported certificates.

You use this identifier for working with profiles and partner profiles.

attrNotAfterDate

Type: string

The final date that the certificate is valid.

attrNotBeforeDate

Type: string

The earliest date that the certificate is valid.

attrSerial

Type: string

The serial number for the certificate.

attrStatus

Type: string

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

PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

attrType

Type: string

If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY .

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

certificate

Type: string

The file name for the certificate.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

usage

Type: string

Specifies whether this certificate is used for signing or encryption.

activeDate?

Type: string (optional)

An optional date that specifies when the certificate becomes active.

certificateChain?

Type: string (optional)

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

description?

Type: string (optional)

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

inactiveDate?

Type: string (optional)

An optional date that specifies when the certificate becomes inactive.

privateKey?

Type: string (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }