Package software.amazon.awscdk.services.transfer

Class CfnHostKey

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.CfnHostKey
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IHostKeyRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:20.654Z") @Stability(Stable) public class CfnHostKey extends CfnResource implements IInspectable, IHostKeyRef, ITaggableV2
Resource type definition for AWS::Transfer::HostKey.

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.*;
 CfnHostKey cfnHostKey = CfnHostKey.Builder.create(this, "MyCfnHostKey")
         .serverId("serverId")
         // the properties below are optional
         .description("description")
         .hostKeyBody("hostKeyBody")
         .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

    • CfnHostKey

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

    • CfnHostKey

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

    • CfnHostKey

      @Stability(Stable) public CfnHostKey(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnHostKeyProps props)
      Create a new AWS::Transfer::HostKey.

      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

    • arnForHostKey

      @Stability(Stable) @NotNull public static String arnForHostKey(@NotNull IHostKeyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnHostKey

      @Stability(Stable) @NotNull public static Boolean isCfnHostKey(@NotNull Object x)
      Checks whether the given object is a CfnHostKey.

      Parameters:
      x - 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 host key.

    • getAttrDateImported

      @Stability(Stable) @NotNull public String getAttrDateImported()
      The date on which the host key was added to the server.

    • getAttrHostKeyFingerprint

      @Stability(Stable) @NotNull public String getAttrHostKeyFingerprint()
      The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

    • getAttrHostKeyId

      @Stability(Stable) @NotNull public String getAttrHostKeyId()
      A unique identifier for the host key.

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      The encryption algorithm that is used for the host key.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getHostKeyRef

      @Stability(Stable) @NotNull public HostKeyReference getHostKeyRef()
      A reference to a HostKey resource.
      Specified by:
      getHostKeyRef in interface IHostKeyRef

    • getServerId

      @Stability(Stable) @NotNull public String getServerId()
      The identifier of the server that contains the host key.

    • setServerId

      @Stability(Stable) public void setServerId(@NotNull String value)
      The identifier of the server that contains the host key.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The text description for this host key.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The text description for this host key.

    • getHostKeyBody

      @Stability(Stable) @Nullable public String getHostKeyBody()
      The private key portion of an SSH key pair.

    • setHostKeyBody

      @Stability(Stable) public void setHostKeyBody(@Nullable String value)
      The private key portion of an SSH key pair.

    • getTags

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

    • setTags

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