UpdateHostKeyRequest
¶
Source code in docs_src/capo_transfer/types/update_host_key_request.py
description
instance-attribute
¶
description: NotRequired[HostKeyDescription]
An updated description for the host key.
host_key_id
instance-attribute
¶
host_key_id: HostKeyId
The identifier of the host key that you are updating.
kms_key
instance-attribute
¶
kms_key: NotRequired[KmsKey]
The Amazon Resource Name (ARN) of the KMS key used to encrypt the Secrets Manager secret that stores the host key. If you specify a customer managed key, its key policy must allow the AWSServiceRoleForTransfer service-linked role to decrypt the secret. If you don't specify a value, Transfer Family uses the Amazon Web Services managed key for Secrets Manager.
server_id
instance-attribute
¶
server_id: ServerId
The identifier of the server that contains the host key that you are updating.
storage_type
instance-attribute
¶
storage_type: NotRequired[HostKeyStorageType]
Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER). When you specify SECRETS_MANAGER, Transfer Family stores the private host key material in an Secrets Manager secret.