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,
  encrypted: false,
  kms_key_id: "KmsKeyId",
  role_name: "String",
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, 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_dataTypes::ClientData

The client-specific data.

Returns:



29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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_tokenString

Token to enable idempotency for VM import requests.

Returns:

  • (String)


29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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

#descriptionString

The description string for the import snapshot task.

Returns:

  • (String)


29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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_containerTypes::SnapshotDiskContainer

Information about the disk container.



29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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_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)


29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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

#encryptedBoolean

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.

Returns:

  • (Boolean)


29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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_idString

An identifier for the symmetric 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. 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.

  • 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.

Amazon EBS does not support asymmetric CMKs.

Returns:

  • (String)


29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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_nameString

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

Returns:

  • (String)


29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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_specificationsArray<Types::TagSpecification>

The tags to apply to the snapshot being imported.

Returns:



29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 29257

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