com.amazonaws.services.storagegateway.model

Class UpdateChapCredentialsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.UpdateChapCredentialsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateChapCredentialsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateChapCredentials operation.

This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

IMPORTANT: When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

See Also:

AWSStorageGateway.updateChapCredentials(UpdateChapCredentialsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateChapCredentialsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateChapCredentialsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getInitiatorName() The iSCSI initiator that connects to the target.
String	getSecretToAuthenticateInitiator() The secret key that the initiator (e.g.
String	getSecretToAuthenticateTarget() The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g.
String	getTargetARN() The Amazon Resource Name (ARN) of the iSCSI volume target.
int	hashCode()
void	setInitiatorName(String initiatorName) The iSCSI initiator that connects to the target.
void	setSecretToAuthenticateInitiator(String secretToAuthenticateInitiator) The secret key that the initiator (e.g.
void	setSecretToAuthenticateTarget(String secretToAuthenticateTarget) The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g.
void	setTargetARN(String targetARN) The Amazon Resource Name (ARN) of the iSCSI volume target.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateChapCredentialsRequest	withInitiatorName(String initiatorName) The iSCSI initiator that connects to the target.
UpdateChapCredentialsRequest	withSecretToAuthenticateInitiator(String secretToAuthenticateInitiator) The secret key that the initiator (e.g.
UpdateChapCredentialsRequest	withSecretToAuthenticateTarget(String secretToAuthenticateTarget) The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g.
UpdateChapCredentialsRequest	withTargetARN(String targetARN) The Amazon Resource Name (ARN) of the iSCSI volume target.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateChapCredentialsRequest

public UpdateChapCredentialsRequest()

Method Detail

getTargetARN

public String getTargetARN()

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

Constraints:
Length: 50 - 800

Returns:

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

setTargetARN

public void setTargetARN(String targetARN)

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

Constraints:
Length: 50 - 800

Parameters:

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

withTargetARN

public UpdateChapCredentialsRequest withTargetARN(String targetARN)

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

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

Constraints:
Length: 50 - 800

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSecretToAuthenticateInitiator

public String getSecretToAuthenticateInitiator()

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

Constraints:
Length: 12 - 16

Returns:

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

setSecretToAuthenticateInitiator

public void setSecretToAuthenticateInitiator(String secretToAuthenticateInitiator)

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

Constraints:
Length: 12 - 16

Parameters:

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

withSecretToAuthenticateInitiator

public UpdateChapCredentialsRequest withSecretToAuthenticateInitiator(String secretToAuthenticateInitiator)

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

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

Constraints:
Length: 12 - 16

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getInitiatorName

public String getInitiatorName()

The iSCSI initiator that connects to the target.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

Returns:

The iSCSI initiator that connects to the target.

setInitiatorName

public void setInitiatorName(String initiatorName)

The iSCSI initiator that connects to the target.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

Parameters:

initiatorName - The iSCSI initiator that connects to the target.

withInitiatorName

public UpdateChapCredentialsRequest withInitiatorName(String initiatorName)

The iSCSI initiator that connects to the target.

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

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

Parameters:

initiatorName - The iSCSI initiator that connects to the target.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecretToAuthenticateTarget

public String getSecretToAuthenticateTarget()

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

Constraints:
Length: 12 - 16

Returns:

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

setSecretToAuthenticateTarget

public void setSecretToAuthenticateTarget(String secretToAuthenticateTarget)

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

Constraints:
Length: 12 - 16

Parameters:

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

withSecretToAuthenticateTarget

public UpdateChapCredentialsRequest withSecretToAuthenticateTarget(String secretToAuthenticateTarget)

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

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

Constraints:
Length: 12 - 16

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public UpdateChapCredentialsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()