Class: Aws::StorageGateway::Types::UpdateChapCredentialsInput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass UpdateChapCredentialsInput data as a hash:

{
  target_arn: "TargetARN", # required
  secret_to_authenticate_initiator: "ChapSecret", # required
  initiator_name: "IqnName", # required
  secret_to_authenticate_target: "ChapSecret",
}

A JSON object containing one or more of the following fields:

  • UpdateChapCredentialsInput$InitiatorName

  • UpdateChapCredentialsInput$SecretToAuthenticateInitiator

  • UpdateChapCredentialsInput$SecretToAuthenticateTarget

  • UpdateChapCredentialsInput$TargetARN

Constant Summary collapse

SENSITIVE =
[:secret_to_authenticate_initiator, :secret_to_authenticate_target]

Instance Attribute Summary collapse

Instance Attribute Details

#initiator_nameString

The iSCSI initiator that connects to the target.

Returns:

  • (String)


6530
6531
6532
6533
6534
6535
6536
6537
# File 'lib/aws-sdk-storagegateway/types.rb', line 6530

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :secret_to_authenticate_target)
  SENSITIVE = [:secret_to_authenticate_initiator, :secret_to_authenticate_target]
  include Aws::Structure
end

#secret_to_authenticate_initiatorString

The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

<note markdown=“1”> The secret key must be between 12 and 16 bytes when encoded in UTF-8.

</note>

Returns:

  • (String)


6530
6531
6532
6533
6534
6535
6536
6537
# File 'lib/aws-sdk-storagegateway/types.rb', line 6530

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :secret_to_authenticate_target)
  SENSITIVE = [:secret_to_authenticate_initiator, :secret_to_authenticate_target]
  include Aws::Structure
end

#secret_to_authenticate_targetString

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

<note markdown=“1”> The secret key must be between 12 and 16 bytes when encoded in UTF-8.

</note>

Returns:

  • (String)


6530
6531
6532
6533
6534
6535
6536
6537
# File 'lib/aws-sdk-storagegateway/types.rb', line 6530

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :secret_to_authenticate_target)
  SENSITIVE = [:secret_to_authenticate_initiator, :secret_to_authenticate_target]
  include Aws::Structure
end

#target_arnString

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

Returns:

  • (String)


6530
6531
6532
6533
6534
6535
6536
6537
# File 'lib/aws-sdk-storagegateway/types.rb', line 6530

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :secret_to_authenticate_target)
  SENSITIVE = [:secret_to_authenticate_initiator, :secret_to_authenticate_target]
  include Aws::Structure
end