You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::ImportSnapshotRequest

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 ImportSnapshotRequest data as a hash:

{
  client_data: {
    comment: "String",
    upload_end: Time.now,
    upload_size: 1.0,
    upload_start: Time.now,
  },
  client_token: "String",
  description: "String",
  disk_container: {
    description: "String",
    format: "String",
    url: "String",
    user_bucket: {
      s3_bucket: "String",
      s3_key: "String",
    },
  },
  dry_run: false,
  role_name: "String",
}

Contains the parameters for ImportSnapshot.

Instance Attribute Summary collapse

Instance Attribute Details

#client_dataTypes::ClientData

The client-specific data.

Returns:



16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16540

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :role_name)
  include Aws::Structure
end

#client_tokenString

Token to enable idempotency for VM import requests.

Returns:

  • (String)


16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16540

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :role_name)
  include Aws::Structure
end

#descriptionString

The description string for the import snapshot task.

Returns:

  • (String)


16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16540

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :role_name)
  include Aws::Structure
end

#disk_containerTypes::SnapshotDiskContainer

Information about the disk container.



16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16540

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :role_name)
  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)


16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16540

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :role_name)
  include Aws::Structure
end

#role_nameString

The name of the role to use when not using the default role, 'vmimport'.

Returns:

  • (String)


16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16540

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :role_name)
  include Aws::Structure
end