AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateReplaceRootVolumeTask operation.
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.
For more information, see Replace a root volume in the Amazon EC2 User Guide.
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
public class CreateReplaceRootVolumeTaskRequest : AmazonEC2Request IAmazonWebServiceRequest
The CreateReplaceRootVolumeTaskRequest type exposes the following members
Name | Description | |
---|---|---|
![]() |
CreateReplaceRootVolumeTaskRequest() |
Name | Type | Description | |
---|---|---|---|
![]() |
ClientToken | System.String |
Gets and sets the property 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. |
![]() |
DeleteReplacedRootVolume | System.Nullable<System.Boolean> |
Gets and sets the property DeleteReplacedRootVolume.
Indicates whether to automatically delete the original root volume after the root
volume replacement task completes. To delete the original root volume, specify |
![]() |
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property 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 |
![]() |
ImageId | System.String |
Gets and sets the property 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. |
![]() |
InstanceId | System.String |
Gets and sets the property InstanceId. The ID of the instance for which to replace the root volume. |
![]() |
SnapshotId | System.String |
Gets and sets the property 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. |
![]() |
TagSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification> |
Gets and sets the property TagSpecifications. The tags to apply to the root volume replacement task. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
![]() |
VolumeInitializationRate | System.Nullable<System.Int64> |
Gets and sets the property VolumeInitializationRate. Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. Omit this parameter if:
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide. Valid range: 100 - 300 MiB/s |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer