Class DescribeChapCredentialsResult

    • Constructor Detail

      • DescribeChapCredentialsResult

        public DescribeChapCredentialsResult()
    • Method Detail

      • getChapCredentials

        public List<ChapInfo> getChapCredentials()

        An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

        Returns:
        An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

      • setChapCredentials

        public void setChapCredentials​(Collection<ChapInfo> chapCredentials)

        An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

        Parameters:
        chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

      • withChapCredentials

        public DescribeChapCredentialsResult withChapCredentials​(ChapInfo... chapCredentials)

        An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

        NOTE: This method appends the values to the existing list (if any). Use setChapCredentials(java.util.Collection) or withChapCredentials(java.util.Collection) if you want to override the existing values.

        Parameters:
        chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

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

        public DescribeChapCredentialsResult withChapCredentials​(Collection<ChapInfo> chapCredentials)

        An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

        Parameters:
        chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

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

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

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

        Returns:
        Returns a reference to this 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