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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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,
  encrypted: false,
  kms_key_id: "String",
  role_name: "String",
}

Contains the parameters for ImportSnapshot.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_data ⇒ Types::ClientData

The client-specific data.

Returns:



21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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

#client_token ⇒ String

Token to enable idempotency for VM import requests.

Returns:

  • (String) 


21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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

#description ⇒ String

The description string for the import snapshot task.

Returns:

  • (String) 


21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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

#disk_container ⇒ Types::SnapshotDiskContainer

Information about the disk container.

Returns:



21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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


21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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

#encrypted ⇒ Boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK 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) 


21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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

#kms_key_id ⇒ String

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

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

  • Key ID

  • Key alias, in the form ‘alias/ExampleAlias `

  • ARN using key ID. The ID ARN contains the ‘arn:aws:kms` namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the `key` namespace, and then the CMK 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 CMK, the AWS account ID of the CMK owner, the `alias` namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS 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 CMK must exist in the region that the snapshot is being copied to.

Returns:

  • (String) 


21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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

#role_name ⇒ String

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

Returns:

  • (String) 


21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
 
# File 'lib/aws-sdk-ec2/types.rb', line 21982

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