Class: Aws::Transfer::Types::UpdateHostKeyRequest

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::UpdateHostKeyRequest

Defined in:

gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  An updated description for the host key.

• #host_key_id ⇒ String

  The identifier of the host key that you are updating.

• #kms_key ⇒ String

  The Amazon Resource Name (ARN) of the KMS key used to encrypt the Secrets Manager secret that stores the host key.

• #server_id ⇒ String

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

• #storage_type ⇒ String

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

Instance Attribute Details

#description ⇒ String

An updated description for the host key.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7462

class UpdateHostKeyRequest < Struct.new(
  :server_id,
  :host_key_id,
  :description,
  :storage_type,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#host_key_id ⇒ String

The identifier of the host key that you are updating.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7462

class UpdateHostKeyRequest < Struct.new(
  :server_id,
  :host_key_id,
  :description,
  :storage_type,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

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:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7462

class UpdateHostKeyRequest < Struct.new(
  :server_id,
  :host_key_id,
  :description,
  :storage_type,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#server_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7462

class UpdateHostKeyRequest < Struct.new(
  :server_id,
  :host_key_id,
  :description,
  :storage_type,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

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:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7462

class UpdateHostKeyRequest < Struct.new(
  :server_id,
  :host_key_id,
  :description,
  :storage_type,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end