Interface UpdateHostKeyRequest.Builder

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

  • Method Details

    • serverId

      UpdateHostKeyRequest.Builder serverId(String serverId)

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

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

    • hostKeyId

      UpdateHostKeyRequest.Builder hostKeyId(String hostKeyId)

      The identifier of the host key that you are updating.

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

    • description

      UpdateHostKeyRequest.Builder description(String description)

      An updated description for the host key.

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

    • storageType

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

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

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

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

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