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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ImportSnapshotRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_data ⇒ Types::ClientData

  The client-specific data.

• #client_token ⇒ String

  Token to enable idempotency for VM import requests.

• #description ⇒ String

  The description string for the import snapshot task.

• #disk_container ⇒ Types::SnapshotDiskContainer

  Information about the disk container.

• #dry_run ⇒ Boolean

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

• #encrypted ⇒ Boolean

  Specifies whether the destination snapshot of the imported image should be encrypted.

• #kms_key_id ⇒ String

  An identifier for the symmetric KMS key to use when creating the encrypted snapshot.

• #role_name ⇒ String

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

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the import snapshot task during creation.

Instance Attribute Details

#client_data ⇒ Types::ClientData

The client-specific data.

Returns:

• (Types::ClientData)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Token to enable idempotency for VM import requests.

Returns:

• (String)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description string for the import snapshot task.

Returns:

• (String)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#disk_container ⇒ Types::SnapshotDiskContainer

Information about the disk container.

Returns:

• (Types::SnapshotDiskContainer)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  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 'lib/aws-sdk-ec2/types.rb', line 39283

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using ‘KmsKeyId`. For more information, see [Amazon EBS Encryption] in the *Amazon Elastic Compute Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html

Returns:

• (Boolean)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a ‘KmsKeyId` is specified, the `Encrypted` flag must also be set.

The KMS key identifier may be provided in any of the following formats:

• Key ID

• Key alias

• ARN using key ID. The ID ARN contains the ‘arn:aws:kms` namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the `key` namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the ‘arn:aws:kms` namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the `alias` namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses ‘KmsKeyId` asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the snapshot is being copied to.

Amazon EBS does not support asymmetric KMS keys.

Returns:

• (String)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ String

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

Returns:

• (String)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the import snapshot task during creation.

Returns:

• (Array<Types::TagSpecification>)

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

class ImportSnapshotRequest < Struct.new(
  :client_data,
  :client_token,
  :description,
  :disk_container,
  :dry_run,
  :encrypted,
  :kms_key_id,
  :role_name,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end