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: "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_dataTypes::ClientData

The client-specific data.

Returns:



34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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)


34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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)


34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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.



34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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)


34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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

Returns:

  • (Boolean)


34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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

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


34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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)


34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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 import snapshot task during creation.

Returns:



34371
34372
34373
34374
34375
34376
34377
34378
34379
34380
34381
34382
34383
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34371

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