AWS::Transfer::Certificate - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Transfer::Certificate

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Transfer::Certificate",
  "Properties" : {
      "ActiveDate" : String,
      "Certificate" : String,
      "CertificateChain" : String,
      "Description" : String,
      "InactiveDate" : String,
      "PrivateKey" : String,
      "Tags" : [ Tag, ... ],
      "Usage" : String
    }
}

YAML

Type: AWS::Transfer::Certificate
Properties: 
  ActiveDate: String
  Certificate: String
  CertificateChain: String
  Description: String
  InactiveDate: String
  PrivateKey: String
  Tags: 
    - Tag
  Usage: String

Properties

ActiveDate

An optional date that specifies when the certificate becomes active.

Required: No

Type: String

Update requires: No interruption

Certificate

The file name for the certificate.

Required: Yes

Type: String

Minimum: 1

Maximum: 16384

Pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]*

Update requires: Replacement

CertificateChain

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

Required: No

Type: String

Minimum: 1

Maximum: 2097152

Pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]*

Update requires: Replacement

Description

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

Required: No

Type: String

Minimum: 1

Maximum: 200

Pattern: ^[\p{Graph}]+

Update requires: No interruption

InactiveDate

An optional date that specifies when the certificate becomes inactive.

Required: No

Type: String

Update requires: No interruption

PrivateKey

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

Required: No

Type: String

Update requires: Replacement

Tags

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

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

Usage

Specifies whether this certificate is used for signing or encryption.

Required: Yes

Type: String

Allowed values: ENCRYPTION | SIGNING

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the certificateId, such as cert-1c698edce1654f869.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

Arn

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

CertificateId

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

NotAfterDate

The final date that the certificate is valid.

NotBeforeDate

The earliest date that the certificate is valid.

Serial

The serial number for the certificate.

Status

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

Type

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.