We recommend new projects start with resources from the AWS provider.
published on Thursday, Oct 22, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Server
Id string - The identifier of the server that contains the host key.
- Description string
- The text description for this host key.
- Host
Key stringBody - 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 Pulumi.Aws Native. Transfer. Host Key Storage Type - 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.
-
List<Pulumi.
Aws Native. Inputs. Tag> - 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 stringBody - 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 HostKey Storage Type - 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.
-
Tag
Args - 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_ stringbody - 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.
- list(object)
- 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 StringBody - 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 HostKey Storage Type - 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.
- List<Tag>
- 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 stringBody - 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 HostKey Storage Type - 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.
- 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_ strbody - 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 HostKey Storage Type - 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.
-
Sequence[Tag
Args] - 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 StringBody - 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.
- 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.
- Date
Imported string - The date on which the host key was added to the server.
- Host
Key stringFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- Host
Key stringId - 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.
- Date
Imported string - The date on which the host key was added to the server.
- Host
Key stringFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- Host
Key stringId - 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.
- date_
imported string - The date on which the host key was added to the server.
- host_
key_ stringfingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- host_
key_ stringid - 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.
- date
Imported String - The date on which the host key was added to the server.
- host
Key StringFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- host
Key StringId - 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.
- date
Imported string - The date on which the host key was added to the server.
- host
Key stringFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- host
Key stringId - 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 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_ strfingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- host_
key_ strid - 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.
- date
Imported String - The date on which the host key was added to the server.
- host
Key StringFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
- host
Key StringId - 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.
Supporting Types
HostKeyStorageType, HostKeyStorageTypeArgs
- Service
Managed SERVICE_MANAGED- Secrets
Manager SECRETS_MANAGER
- Host
Key Storage Type Service Managed SERVICE_MANAGED- Host
Key Storage Type Secrets Manager SECRETS_MANAGER
- "SERVICE_MANAGED"
SERVICE_MANAGED- "SECRETS_MANAGER"
SECRETS_MANAGER
- Service
Managed SERVICE_MANAGED- Secrets
Manager SECRETS_MANAGER
- Service
Managed SERVICE_MANAGED- Secrets
Manager 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.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Thursday, Oct 22, 2026 by Pulumi