Package software.amazon.awscdk.services.transfer

Class CfnCertificate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.transfer.CfnCertificate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.909Z") @Stability(Stable) public class CfnCertificate extends CfnResource implements 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 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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnCertificateProps props)
      Create a new AWS::Transfer::Certificate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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 .

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key-value pairs that can be used to group and search for certificates.

    • 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 whether this certificate is used for signing or encryption.

    • setUsage

      @Stability(Stable) public void setUsage(@NotNull String value)
      Specifies whether this certificate is used for signing or encryption.

    • 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.