ec2_create_replace_root_volume_task: Replaces the EBS-backed root volume for a running instance...

View source: R/ec2_operations.R

ec2_create_replace_root_volume_taskR Documentation

Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance

Description

Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance.

See https://www.paws-r-sdk.com/docs/ec2_create_replace_root_volume_task/ for full documentation.

Usage

ec2_create_replace_root_volume_task(
  InstanceId,
  SnapshotId = NULL,
  ClientToken = NULL,
  DryRun = NULL,
  TagSpecifications = NULL,
  ImageId = NULL,
  DeleteReplacedRootVolume = NULL
)

Arguments

InstanceId

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

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.

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.

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.

TagSpecifications

The tags to apply to the root volume replacement task.

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.

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.


paws.compute documentation built on Sept. 12, 2023, 1:28 a.m.