Package software.amazon.awscdk.services.transfer

Class CfnCertificate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnCertificate
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, ICertificateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:16.555Z") @Stability(Stable) public class CfnCertificate extends CfnResource implements IInspectable, ICertificateRef, ITaggable
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

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 DaysUntilExpiry metric to your account. > If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

  • Units: Count (days)
  • Dimensions: CertificateId (always present), Description (if provided during certificate import)
  • Statistics: Minimum, Maximum, Average
  • Frequency: Published daily

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnCertificate cfnCertificate = CfnCertificate.Builder.create(this, "MyCfnCertificate")
         .certificate("certificate")
         .usage("usage")
         // the properties below are optional
         .activeDate("activeDate")
         .certificateChain("certificateChain")
         .description("description")
         .inactiveDate("inactiveDate")
         .privateKey("privateKey")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCertificate

      protected CfnCertificate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCertificate

      protected CfnCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCertificate

      @Stability(Stable) public CfnCertificate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCertificateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCertificateArn

      @Stability(Stable) @NotNull public static ICertificateRef fromCertificateArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICertificateRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCertificateId

      @Stability(Stable) @NotNull public static ICertificateRef fromCertificateId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String certificateId)
      Creates a new ICertificateRef from a certificateId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      certificateId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The unique Amazon Resource Name (ARN) for the certificate.

    • getAttrCertificateId

      @Stability(Stable) @NotNull public String getAttrCertificateId()
      An array of identifiers for the imported certificates.

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

    • getAttrNotAfterDate

      @Stability(Stable) @NotNull public String getAttrNotAfterDate()
      The final date that the certificate is valid.

    • getAttrNotBeforeDate

      @Stability(Stable) @NotNull public String getAttrNotBeforeDate()
      The earliest date that the certificate is valid.

    • getAttrSerial

      @Stability(Stable) @NotNull public String getAttrSerial()
      The serial number for the certificate.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The certificate can be either ACTIVE , PENDING_ROTATION , or INACTIVE .

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

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      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 .

    • getCertificateRef

      @Stability(Stable) @NotNull public CertificateReference getCertificateRef()
      A reference to a Certificate resource.
      Specified by:
      getCertificateRef in interface ICertificateRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCertificate

      @Stability(Stable) @NotNull public String getCertificate()
      The file name for the certificate.

    • setCertificate

      @Stability(Stable) public void setCertificate(@NotNull String value)
      The file name for the certificate.

    • getUsage

      @Stability(Stable) @NotNull public String getUsage()
      Specifies how this certificate is used.

      It can be used in the following ways:.

    • setUsage

      @Stability(Stable) public void setUsage(@NotNull String value)
      Specifies how this certificate is used.

      It can be used in the following ways:.

    • getActiveDate

      @Stability(Stable) @Nullable public String getActiveDate()
      An optional date that specifies when the certificate becomes active.

    • setActiveDate

      @Stability(Stable) public void setActiveDate(@Nullable String value)
      An optional date that specifies when the certificate becomes active.

    • getCertificateChain

      @Stability(Stable) @Nullable public String getCertificateChain()
      The list of certificates that make up the chain for the certificate.

    • setCertificateChain

      @Stability(Stable) public void setCertificateChain(@Nullable String value)
      The list of certificates that make up the chain for the certificate.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The name or description that's used to identity the certificate.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The name or description that's used to identity the certificate.

    • getInactiveDate

      @Stability(Stable) @Nullable public String getInactiveDate()
      An optional date that specifies when the certificate becomes inactive.

    • setInactiveDate

      @Stability(Stable) public void setInactiveDate(@Nullable String value)
      An optional date that specifies when the certificate becomes inactive.

    • getPrivateKey

      @Stability(Stable) @Nullable public String getPrivateKey()
      The file that contains the private key for the certificate that's being imported.

    • setPrivateKey

      @Stability(Stable) public void setPrivateKey(@Nullable String value)
      The file that contains the private key for the certificate that's being imported.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs that can be used to group and search for certificates.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for certificates.