1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. transfer
  6. HostKey

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.83.1
published on Thursday, Oct 22, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.83.1
published on Thursday, Oct 22, 2026 by Pulumi

    Resource type definition for AWS::Transfer::HostKey

    Create HostKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HostKey(name: string, args: HostKeyArgs, opts?: CustomResourceOptions);
    @overload
    def HostKey(resource_name: str,
                args: HostKeyArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def HostKey(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                server_id: Optional[str] = None,
                description: Optional[str] = None,
                host_key_body: Optional[str] = None,
                kms_key: Optional[str] = None,
                storage_type: Optional[HostKeyStorageType] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewHostKey(ctx *Context, name string, args HostKeyArgs, opts ...ResourceOption) (*HostKey, error)
    public HostKey(string name, HostKeyArgs args, CustomResourceOptions? opts = null)
    public HostKey(String name, HostKeyArgs args)
    public HostKey(String name, HostKeyArgs args, CustomResourceOptions options)
    
    type: aws-native:transfer:HostKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_transfer_host_key" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args HostKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HostKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HostKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    HostKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HostKey resource accepts the following input properties:

    ServerId string
    The identifier of the server that contains the host key.
    Description string
    The text description for this host key.
    HostKeyBody string
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    KmsKey string
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    StorageType Pulumi.AwsNative.Transfer.HostKeyStorageType
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Key-value pairs that can be used to group and search for host keys.
    ServerId string
    The identifier of the server that contains the host key.
    Description string
    The text description for this host key.
    HostKeyBody string
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    KmsKey string
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    StorageType HostKeyStorageType
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    Tags TagArgs
    Key-value pairs that can be used to group and search for host keys.
    server_id string
    The identifier of the server that contains the host key.
    description string
    The text description for this host key.
    host_key_body string
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    kms_key string
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    storage_type "SERVICE_MANAGED" | "SECRETS_MANAGER"
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    tags list(object)
    Key-value pairs that can be used to group and search for host keys.
    serverId String
    The identifier of the server that contains the host key.
    description String
    The text description for this host key.
    hostKeyBody String
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    kmsKey String
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    storageType HostKeyStorageType
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    tags List<Tag>
    Key-value pairs that can be used to group and search for host keys.
    serverId string
    The identifier of the server that contains the host key.
    description string
    The text description for this host key.
    hostKeyBody string
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    kmsKey string
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    storageType HostKeyStorageType
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    tags Tag[]
    Key-value pairs that can be used to group and search for host keys.
    server_id str
    The identifier of the server that contains the host key.
    description str
    The text description for this host key.
    host_key_body str
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    kms_key str
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    storage_type HostKeyStorageType
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    tags Sequence[TagArgs]
    Key-value pairs that can be used to group and search for host keys.
    serverId String
    The identifier of the server that contains the host key.
    description String
    The text description for this host key.
    hostKeyBody String
    The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    kmsKey String
    The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key. Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
    storageType "SERVICE_MANAGED" | "SECRETS_MANAGER"
    The type of storage used for the host key. SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.
    tags List<Property Map>
    Key-value pairs that can be used to group and search for host keys.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HostKey resource produces the following output properties:

    Arn string
    The unique Amazon Resource Name (ARN) for the host key.
    DateImported string
    The date on which the host key was added to the server.
    HostKeyFingerprint string
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    HostKeyId string
    A unique identifier for the host key.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretId string
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    Type string
    The encryption algorithm that is used for the host key.
    Arn string
    The unique Amazon Resource Name (ARN) for the host key.
    DateImported string
    The date on which the host key was added to the server.
    HostKeyFingerprint string
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    HostKeyId string
    A unique identifier for the host key.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretId string
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    Type string
    The encryption algorithm that is used for the host key.
    arn string
    The unique Amazon Resource Name (ARN) for the host key.
    date_imported string
    The date on which the host key was added to the server.
    host_key_fingerprint string
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    host_key_id string
    A unique identifier for the host key.
    id string
    The provider-assigned unique ID for this managed resource.
    secret_id string
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    type string
    The encryption algorithm that is used for the host key.
    arn String
    The unique Amazon Resource Name (ARN) for the host key.
    dateImported String
    The date on which the host key was added to the server.
    hostKeyFingerprint String
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    hostKeyId String
    A unique identifier for the host key.
    id String
    The provider-assigned unique ID for this managed resource.
    secretId String
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    type String
    The encryption algorithm that is used for the host key.
    arn string
    The unique Amazon Resource Name (ARN) for the host key.
    dateImported string
    The date on which the host key was added to the server.
    hostKeyFingerprint string
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    hostKeyId string
    A unique identifier for the host key.
    id string
    The provider-assigned unique ID for this managed resource.
    secretId string
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    type string
    The encryption algorithm that is used for the host key.
    arn str
    The unique Amazon Resource Name (ARN) for the host key.
    date_imported str
    The date on which the host key was added to the server.
    host_key_fingerprint str
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    host_key_id str
    A unique identifier for the host key.
    id str
    The provider-assigned unique ID for this managed resource.
    secret_id str
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    type str
    The encryption algorithm that is used for the host key.
    arn String
    The unique Amazon Resource Name (ARN) for the host key.
    dateImported String
    The date on which the host key was added to the server.
    hostKeyFingerprint String
    The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
    hostKeyId String
    A unique identifier for the host key.
    id String
    The provider-assigned unique ID for this managed resource.
    secretId String
    The Amazon Resource Name (ARN) of the Secrets Manager secret that holds the host key. Returned only when StorageType is SECRETS_MANAGER.
    type String
    The encryption algorithm that is used for the host key.

    Supporting Types

    HostKeyStorageType, HostKeyStorageTypeArgs

    ServiceManaged
    SERVICE_MANAGED
    SecretsManager
    SECRETS_MANAGER
    HostKeyStorageTypeServiceManaged
    SERVICE_MANAGED
    HostKeyStorageTypeSecretsManager
    SECRETS_MANAGER
    "SERVICE_MANAGED"
    SERVICE_MANAGED
    "SECRETS_MANAGER"
    SECRETS_MANAGER
    ServiceManaged
    SERVICE_MANAGED
    SecretsManager
    SECRETS_MANAGER
    ServiceManaged
    SERVICE_MANAGED
    SecretsManager
    SECRETS_MANAGER
    SERVICE_MANAGED
    SERVICE_MANAGED
    SECRETS_MANAGER
    SECRETS_MANAGER
    "SERVICE_MANAGED"
    SERVICE_MANAGED
    "SECRETS_MANAGER"
    SECRETS_MANAGER

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.83.1
    published on Thursday, Oct 22, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial