Skip to content

DescribedHostKey

Source code in docs_src/capo_transfer/types/described_host_key.py
class DescribedHostKey(TypedDict, closed=True):
    arn: "capo_transfer.types.arn.Arn"
    """<p>The unique Amazon Resource Name (ARN) for the host key.</p>"""
    host_key_id: NotRequired["capo_transfer.types.host_key_id.HostKeyId"]
    """<p>A unique identifier for the host key.</p>"""
    host_key_fingerprint: NotRequired[
        "capo_transfer.types.host_key_fingerprint.HostKeyFingerprint"
    ]
    """<p>The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.</p>"""
    description: NotRequired[
        "capo_transfer.types.host_key_description.HostKeyDescription"
    ]
    """<p>The text description for this host key.</p>"""
    type: NotRequired["capo_transfer.types.host_key_type.HostKeyType"]
    """<p>The encryption algorithm that is used for the host key. The <code>Type</code> parameter is specified by using one of the following values:</p> <ul> <li> <p> <code>ssh-rsa</code> </p> </li> <li> <p> <code>ssh-ed25519</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp256</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp384</code> </p> </li> <li> <p> <code>ecdsa-sha2-nistp521</code> </p> </li> </ul>"""
    date_imported: NotRequired["capo_transfer.types.date_imported.DateImported"]
    """<p>The date on which the host key was added to the server.</p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for host keys.</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>).</p>"""
    secret_id: NotRequired["capo_transfer.types.secret_id.SecretId"]
    """<p>The ARN of the Secrets Manager secret that stores the host key material, when <code>StorageType</code> is <code>SECRETS_MANAGER</code>.</p>"""

arn instance-attribute

arn: Arn

The unique Amazon Resource Name (ARN) for the host key.

date_imported instance-attribute

date_imported: NotRequired[DateImported]

The date on which the host key was added to the server.

description instance-attribute

description: NotRequired[HostKeyDescription]

The text description for this host key.

host_key_fingerprint instance-attribute

host_key_fingerprint: NotRequired[HostKeyFingerprint]

The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

host_key_id instance-attribute

host_key_id: NotRequired[HostKeyId]

A unique identifier for the host key.

secret_id instance-attribute

secret_id: NotRequired[SecretId]

The ARN of the Secrets Manager secret that stores the host key material, when StorageType is SECRETS_MANAGER.

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).

tags instance-attribute

tags: NotRequired[Tags]

Key-value pairs that can be used to group and search for host keys.

type instance-attribute

type: NotRequired[HostKeyType]

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

  • ssh-rsa

  • ssh-ed25519

  • ecdsa-sha2-nistp256

  • ecdsa-sha2-nistp384

  • ecdsa-sha2-nistp521