Interface AttachVolumeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AttachVolumeRequest.Builder,
,AttachVolumeRequest> SdkBuilder<AttachVolumeRequest.Builder,
,AttachVolumeRequest> SdkPojo
,SdkRequest.Builder
,StorageGatewayRequest.Builder
- Enclosing class:
AttachVolumeRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe unique device ID or other distinguishing data that identifies the local disk used to create the volume.gatewayARN
(String gatewayARN) The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.networkInterfaceId
(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest.Builder
build
-
Method Details
-
gatewayARN
The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
- Parameters:
gatewayARN
- The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofarn: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, specifyingTargetName
as myvolume results in the target ARN ofarn: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.
-
volumeARN
The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
- Parameters:
volumeARN
- The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
diskId
The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.
- Parameters:
diskId
- The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AttachVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AttachVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-