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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateReplaceRootVolumeTaskRequest data as a hash:

{
  instance_id: "InstanceId", # required
  snapshot_id: "SnapshotId",
  client_token: "String",
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


8982
8983
8984
8985
8986
8987
8988
8989
8990
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8982

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

#dry_runBoolean

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)


8982
8983
8984
8985
8986
8987
8988
8989
8990
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8982

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

#instance_idString

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

Returns:

  • (String)


8982
8983
8984
8985
8986
8987
8988
8989
8990
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8982

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

#snapshot_idString

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.

Returns:

  • (String)


8982
8983
8984
8985
8986
8987
8988
8989
8990
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8982

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

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the root volume replacement task.

Returns:



8982
8983
8984
8985
8986
8987
8988
8989
8990
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8982

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