You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/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

Instance Attribute Summary collapse

Instance Attribute Details

#initiator_nameString

The iSCSI initiator that connects to the target.

Returns:

  • (String)


3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3685

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :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.

The secret key must be between 12 and 16 bytes when encoded in UTF-8.

Returns:

  • (String)


3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3685

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :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.

The secret key must be between 12 and 16 bytes when encoded in UTF-8.

Returns:

  • (String)


3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3685

class UpdateChapCredentialsInput < Struct.new(
  :target_arn,
  :secret_to_authenticate_initiator,
  :initiator_name,
  :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)


3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3685

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