Class: Aws::EC2::Types::CreateReplaceRootVolumeTaskRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateReplaceRootVolumeTaskRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

• #delete_replaced_root_volume ⇒ Boolean

  Indicates whether to automatically delete the original root volume after the root volume replacement task completes.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #image_id ⇒ String

  The ID of the AMI to use to restore the root volume.

• #instance_id ⇒ String

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

• #snapshot_id ⇒ String

  The ID of the snapshot from which to restore the replacement root volume.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the root volume replacement task.

• #volume_id ⇒ String

  The ID of the volume to use as the replacement root volume.

• #volume_initialization_rate ⇒ Integer

  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.

Instance Attribute Details

#client_token ⇒ 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#delete_replaced_root_volume ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ 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, if you want to restore it to its launch state, or if you want to replace the root volume with a specified volume, omit this parameter.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_id ⇒ 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, if you want to restore the replacement root volume from an AMI, or if you want to replace the root volume with a specified volume, omit this parameter.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the root volume replacement task.

Returns:

• (Array<Types::TagSpecification>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

The ID of the volume to use as the replacement root volume. The specified volume must be in the same Availability Zone as the instance, must be in the available state, and must not be attached to an instance. If the original root volume is encrypted, the specified volume must also be encrypted.

If you want to restore the replacement root volume from a specific snapshot, an AMI, or to its launch state, omit this parameter.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end

#volume_initialization_rate ⇒ Integer

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:

• You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.

  If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.

• You want to create a volume that is initialized at the default rate.

For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.

Valid range: 100 - 300 MiB/s

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15072

class CreateReplaceRootVolumeTaskRequest < Struct.new(
  :instance_id,
  :snapshot_id,
  :client_token,
  :dry_run,
  :tag_specifications,
  :image_id,
  :delete_replaced_root_volume,
  :volume_initialization_rate,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end