Skip to content

UpdateHostKeyRequest

Source code in docs_src/capo_transfer/types/update_host_key_request.py
class UpdateHostKeyRequest(TypedDict, closed=True):
    server_id: "capo_transfer.types.server_id.ServerId"
    """<p>The identifier of the server that contains the host key that you are updating.</p>"""
    host_key_id: "capo_transfer.types.host_key_id.HostKeyId"
    """<p>The identifier of the host key that you are updating.</p>"""
    description: NotRequired[
        "capo_transfer.types.host_key_description.HostKeyDescription"
    ]
    """<p>An updated description for the host key.</p>"""
    storage_type: NotRequired[
        "capo_transfer.types.host_key_storage_type.HostKeyStorageType"
    ]
    """<p>Specifies whether the host key is stored by Transfer Family (<code>SERVICE_MANAGED</code>) or in Secrets Manager (<code>SECRETS_MANAGER</code>). When you specify <code>SECRETS_MANAGER</code>, Transfer Family stores the private host key material in an Secrets Manager secret.</p>"""
    kms_key: NotRequired["capo_transfer.types.kms_key.KmsKey"]
    """<p>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 <code>AWSServiceRoleForTransfer</code> 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.</p>"""

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.