Interface DescribedHostKey.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DescribedHostKey.Builder,DescribedHostKey>, SdkBuilder<DescribedHostKey.Builder,DescribedHostKey>, SdkPojo
Enclosing class:
DescribedHostKey
@Mutable @NotThreadSafe public static interface DescribedHostKey.Builder extends SdkPojo, CopyableBuilder<DescribedHostKey.Builder,DescribedHostKey>

  • Method Details

    • arn

      DescribedHostKey.Builder arn(String arn)

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

      Parameters:
      arn - The unique Amazon Resource Name (ARN) for the host key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostKeyId

      DescribedHostKey.Builder hostKeyId(String hostKeyId)

      A unique identifier for the host key.

      Parameters:
      hostKeyId - A unique identifier for the host key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostKeyFingerprint

      DescribedHostKey.Builder hostKeyFingerprint(String hostKeyFingerprint)

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

      Parameters:
      hostKeyFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      DescribedHostKey.Builder description(String description)

      The text description for this host key.

      Parameters:
      description - The text description for this host key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      DescribedHostKey.Builder type(String type)

      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

      Parameters:
      type - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dateImported

      DescribedHostKey.Builder dateImported(Instant dateImported)

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

      Parameters:
      dateImported - The date on which the host key was added to the server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribedHostKey.Builder tags(Collection<Tag> tags)

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

      Parameters:
      tags - Key-value pairs that can be used to group and search for host keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribedHostKey.Builder tags(Tag... tags)

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

      Parameters:
      tags - Key-value pairs that can be used to group and search for host keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribedHostKey.Builder tags(Consumer<Tag.Builder>... tags)

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

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      DescribedHostKey.Builder storageType(String storageType)

      Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER).

      Parameters:
      storageType - Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      DescribedHostKey.Builder storageType(HostKeyStorageType storageType)

      Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER).

      Parameters:
      storageType - Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secretId

      DescribedHostKey.Builder secretId(String secretId)

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

      Parameters:
      secretId - The ARN of the Secrets Manager secret that stores the host key material, when StorageType is SECRETS_MANAGER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.