Package software.amazon.awssdk.services.ec2.model

Interface CreateReplaceRootVolumeTaskRequest.Builder

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

  • Method Details

    • instanceId

      CreateReplaceRootVolumeTaskRequest.Builder instanceId(String instanceId)

      The ID of the instance for which to replace the root volume.

      Parameters:
      instanceId - The ID of the instance for which to replace the root volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapshotId

      CreateReplaceRootVolumeTaskRequest.Builder snapshotId(String snapshotId)

      The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume.

      If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter.

      Parameters:
      snapshotId - The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume.

      If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter.

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

    • clientToken

      CreateReplaceRootVolumeTaskRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      CreateReplaceRootVolumeTaskRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateReplaceRootVolumeTaskRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the root volume replacement task.

      Parameters:
      tagSpecifications - The tags to apply to the root volume replacement task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateReplaceRootVolumeTaskRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the root volume replacement task.

      Parameters:
      tagSpecifications - The tags to apply to the root volume replacement task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateReplaceRootVolumeTaskRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the root volume replacement task.

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

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

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

    • imageId

      CreateReplaceRootVolumeTaskRequest.Builder imageId(String imageId)

      The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance.

      If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter.

      Parameters:
      imageId - The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance.

      If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter.

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

    • deleteReplacedRootVolume

      CreateReplaceRootVolumeTaskRequest.Builder deleteReplacedRootVolume(Boolean deleteReplacedRootVolume)

      Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify true. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.

      Parameters:
      deleteReplacedRootVolume - Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify true. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateReplaceRootVolumeTaskRequest.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

      CreateReplaceRootVolumeTaskRequest.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.