Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateReplaceRootVolumeTaskRequest

Hierarchy

Index

Properties

Optional ClientToken

ClientToken: undefined | string

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.

Optional DeleteReplacedRootVolume

DeleteReplacedRootVolume: undefined | false | true

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.

Optional DryRun

DryRun: undefined | false | true

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.

Optional ImageId

ImageId: undefined | string

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.

InstanceId

InstanceId: string | undefined

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

Optional SnapshotId

SnapshotId: undefined | string

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.

Optional TagSpecifications

TagSpecifications: TagSpecification[]

The tags to apply to the root volume replacement task.