View a markdown version of this page

AWS::EC2::ReplaceRootVolumeTask - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EC2::ReplaceRootVolumeTask

Information about a root volume replacement task.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::ReplaceRootVolumeTask",
  "Properties" : {
      "DeleteReplacedRootVolume" : Boolean,
      "InstanceId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::ReplaceRootVolumeTask
Properties:
  DeleteReplacedRootVolume: Boolean
  InstanceId: String
  Tags: 
    - Tag

Properties

DeleteReplacedRootVolume

Indicates whether the original root volume is to be deleted after the root volume replacement task completes.

Required: No

Type: Boolean

Update requires: Replacement

InstanceId

The ID of the instance for which the root volume replacement task was created.

Required: Yes

Type: String

Update requires: Replacement

Tags

The tags assigned to the task.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CompleteTime

The time the task completed.

ReplaceRootVolumeTaskId

The ID of the root volume replacement task.

SnapshotId

The ID of the snapshot used to create the replacement root volume.

StartTime

The time the task was started.

TaskState

The state of the task. The task can be in one of the following states:

  • pending - the replacement volume is being created.

  • in-progress - the original volume is being detached and the replacement volume is being attached.

  • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

  • failing - the replacement task is in the process of failing.

  • failed - the replacement task has failed but the original root volume is still attached.

  • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

  • failed-detached - the replacement task has failed and the instance has no root volume attached.