AWS CDK

2.168.0

interface CfnCertificateProps

Language	Type name
.NET	`Amazon.CDK.AWS.Transfer.CfnCertificateProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnCertificateProps`
Java	`software.amazon.awscdk.services.transfer.CfnCertificateProps`
Python	`aws_cdk.aws_transfer.CfnCertificateProps`
TypeScript	`aws-cdk-lib` » `aws_transfer` » `CfnCertificateProps`

Properties for defining a CfnCertificate.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const cfnCertificateProps: transfer.CfnCertificateProps = {
  certificate: 'certificate',
  usage: 'usage',

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

Properties

Name	Type	Description
certificate	`string`	The file name for the certificate.
usage	`string`	Specifies how this certificate is used. It can be used in the following ways:.
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.

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

usage

Type: string

Specifies how this certificate is used. It can be used in the following ways:.

SIGNING : For signing AS2 messages
ENCRYPTION : For encrypting AS2 messages
TLS : For securing AS2 communications sent over HTTPS

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

activeDate?

Type: string (optional)

An optional date that specifies when the certificate becomes active.

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

certificateChain?

Type: string (optional)

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

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

description?

Type: string (optional)

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

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

inactiveDate?

Type: string (optional)

An optional date that specifies when the certificate becomes inactive.

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

privateKey?

Type: string (optional)

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

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

tags?

Type: CfnTag[] (optional)

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

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

← Previous Next →