Interface ImportHostKeyRequest.Builder

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

  • Method Details

    • serverId

      ImportHostKeyRequest.Builder serverId(String serverId)

      The identifier of the server that contains the host key that you are importing.

      Parameters:
      serverId - The identifier of the server that contains the host key that you are importing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostKeyBody

      ImportHostKeyRequest.Builder hostKeyBody(String hostKeyBody)

      The private key portion of an SSH key pair.

      Transfer Family accepts RSA, ECDSA, and ED25519 keys.

      Parameters:
      hostKeyBody - The private key portion of an SSH key pair.

      Transfer Family accepts RSA, ECDSA, and ED25519 keys.

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

    • description

      ImportHostKeyRequest.Builder description(String description)

      The text description that identifies this host key.

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

    • tags

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

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

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

      ImportHostKeyRequest.Builder storageType(String storageType)

      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.

      Parameters:
      storageType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      ImportHostKeyRequest.Builder storageType(HostKeyStorageType storageType)

      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.

      Parameters:
      storageType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKey

      ImportHostKeyRequest.Builder kmsKey(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ImportHostKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ImportHostKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.