Package software.amazon.awssdk.services.storagegateway.model

Interface CreateCachediScsiVolumeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>, SdkBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder
Enclosing class:
CreateCachediScsiVolumeRequest
public static interface CreateCachediScsiVolumeRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>

  • Method Details

    • gatewayARN

      CreateCachediScsiVolumeRequest.Builder gatewayARN(String gatewayARN)
      Sets the value of the GatewayARN property for this object.
      Parameters:
      gatewayARN - The new value for the GatewayARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeSizeInBytes

      CreateCachediScsiVolumeRequest.Builder volumeSizeInBytes(Long volumeSizeInBytes)

      The size of the volume in bytes.

      Parameters:
      volumeSizeInBytes - The size of the volume in bytes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapshotId

      CreateCachediScsiVolumeRequest.Builder snapshotId(String snapshotId)

      The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

      Parameters:
      snapshotId - The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetName

      CreateCachediScsiVolumeRequest.Builder targetName(String targetName)

      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

      Parameters:
      targetName - The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

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

    • sourceVolumeARN

      CreateCachediScsiVolumeRequest.Builder sourceVolumeARN(String sourceVolumeARN)

      The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

      Parameters:
      sourceVolumeARN - The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkInterfaceId

      CreateCachediScsiVolumeRequest.Builder networkInterfaceId(String networkInterfaceId)

      The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

      Valid Values: A valid IP address.

      Parameters:
      networkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

      Valid Values: A valid IP address.

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

    • clientToken

      CreateCachediScsiVolumeRequest.Builder clientToken(String clientToken)

      A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

      Parameters:
      clientToken - A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsEncrypted

      CreateCachediScsiVolumeRequest.Builder kmsEncrypted(Boolean kmsEncrypted)

      Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

      Valid Values: true | false

      Parameters:
      kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

      Valid Values: true | false

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

    • kmsKey

      CreateCachediScsiVolumeRequest.Builder kmsKey(String kmsKey)

      The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

      Parameters:
      kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCachediScsiVolumeRequest.Builder tags(Collection<Tag> tags)

      A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      Parameters:
      tags - A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

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

    • tags

      CreateCachediScsiVolumeRequest.Builder tags(Tag... tags)

      A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      Parameters:
      tags - A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

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

    • tags

      CreateCachediScsiVolumeRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateCachediScsiVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateCachediScsiVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.