feat(client-ec2): Feature supports the replacement of instance root volume using an updated AMI without requiring customers to stop their instance.

Author: awstools

clients/client-ec2/src/EC2.ts

@@ -6003,9 +6003,10 @@ export class EC2 extends EC2Client {
   }
 
   /**
-   * <p>Creates a root volume replacement task for an Amazon EC2 instance. The root volume
-   *       can either be restored to its initial launch state, or it can be restored using a
-   *       specific snapshot.</p>
+   * <p>Replaces the EBS-backed root volume for a <code>running</code> 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.</p>
    *
    *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root">Replace a root volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
    */

clients/client-ec2/src/commands/CreateReplaceRootVolumeTaskCommand.ts

@@ -29,9 +29,10 @@ export interface CreateReplaceRootVolumeTaskCommandInput extends CreateReplaceRo
 export interface CreateReplaceRootVolumeTaskCommandOutput extends CreateReplaceRootVolumeTaskResult, __MetadataBearer {}
 
 /**
- * <p>Creates a root volume replacement task for an Amazon EC2 instance. The root volume
- *       can either be restored to its initial launch state, or it can be restored using a
- *       specific snapshot.</p>
+ * <p>Replaces the EBS-backed root volume for a <code>running</code> 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.</p>
  *
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root">Replace a root volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
  * @example

clients/client-ec2/src/models/models_1.ts

@@ -7172,8 +7172,12 @@ export interface CreateReplaceRootVolumeTaskRequest {
   InstanceId: string | undefined;
 
   /**
-   * <p>The ID of the snapshot from which to restore the replacement root volume. If you want to
-   *       restore the volume to the initial launch state, omit this parameter.</p>
+   * <p>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.</p>
+   *          <p>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.</p>
    */
   SnapshotId?: string;
 
@@ -7195,6 +7199,23 @@ export interface CreateReplaceRootVolumeTaskRequest {
    * <p>The tags to apply to the root volume replacement task.</p>
    */
   TagSpecifications?: TagSpecification[];
+
+  /**
+   * <p>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.</p>
+   *          <p>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.</p>
+   */
+  ImageId?: string;
+
+  /**
+   * <p>Indicates whether to automatically delete the original root volume after the root volume
+   *       replacement task completes. To delete the original root volume, specify <code>true</code>.
+   *       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.</p>
+   */
+  DeleteReplacedRootVolume?: boolean;
 }
 
 export enum ReplaceRootVolumeTaskState {
@@ -7274,6 +7295,22 @@ export interface ReplaceRootVolumeTask {
    * <p>The tags assigned to the task.</p>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>The ID of the AMI used to create the replacement root volume.</p>
+   */
+  ImageId?: string;
+
+  /**
+   * <p>The ID of the snapshot used to create the replacement root volume.</p>
+   */
+  SnapshotId?: string;
+
+  /**
+   * <p>Indicates whether the original root volume is to be deleted after the root volume
+   *       replacement task completes.</p>
+   */
+  DeleteReplacedRootVolume?: boolean;
 }
 
 export interface CreateReplaceRootVolumeTaskResult {

clients/client-ec2/src/protocols/Aws_ec2.ts

@@ -34257,6 +34257,12 @@ const serializeAws_ec2CreateReplaceRootVolumeTaskRequest = (
       entries[loc] = value;
     });
   }
+  if (input.ImageId != null) {
+    entries["ImageId"] = input.ImageId;
+  }
+  if (input.DeleteReplacedRootVolume != null) {
+    entries["DeleteReplacedRootVolume"] = input.DeleteReplacedRootVolume;
+  }
   return entries;
 };
 
@@ -73040,6 +73046,9 @@ const deserializeAws_ec2ReplaceRootVolumeTask = (output: any, context: __SerdeCo
     StartTime: undefined,
     CompleteTime: undefined,
     Tags: undefined,
+    ImageId: undefined,
+    SnapshotId: undefined,
+    DeleteReplacedRootVolume: undefined,
   };
   if (output["replaceRootVolumeTaskId"] !== undefined) {
     contents.ReplaceRootVolumeTaskId = __expectString(output["replaceRootVolumeTaskId"]);
@@ -73061,6 +73070,15 @@ const deserializeAws_ec2ReplaceRootVolumeTask = (output: any, context: __SerdeCo
   } else if (output["tagSet"] !== undefined && output["tagSet"]["item"] !== undefined) {
     contents.Tags = deserializeAws_ec2TagList(__getArrayIfSingleItem(output["tagSet"]["item"]), context);
   }
+  if (output["imageId"] !== undefined) {
+    contents.ImageId = __expectString(output["imageId"]);
+  }
+  if (output["snapshotId"] !== undefined) {
+    contents.SnapshotId = __expectString(output["snapshotId"]);
+  }
+  if (output["deleteReplacedRootVolume"] !== undefined) {
+    contents.DeleteReplacedRootVolume = __parseBoolean(output["deleteReplacedRootVolume"]);
+  }
   return contents;
 };