You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::ExportImageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::ExportImageRequest
- Defined in:
- (unknown)
Overview
When passing ExportImageRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
client_token: "String",
description: "String",
disk_image_format: "VMDK", # required, accepts VMDK, RAW, VHD
dry_run: false,
image_id: "ImageId", # required
s3_export_location: { # required
s3_bucket: "String", # required
s3_prefix: "String",
},
role_name: "String",
tag_specifications: [
{
resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-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, 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",
},
],
},
],
}
Instance Attribute Summary collapse
-
#client_token ⇒ String
Token to enable idempotency for export image requests.
-
#description ⇒ String
A description of the image being exported.
-
#disk_image_format ⇒ String
The disk image format.
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#image_id ⇒ String
The ID of the image.
-
#role_name ⇒ String
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
-
#s3_export_location ⇒ Types::ExportTaskS3LocationRequest
Information about the destination Amazon S3 bucket.
-
#tag_specifications ⇒ Array<Types::TagSpecification>
The tags to apply to the image being exported.
Instance Attribute Details
#client_token ⇒ String
Token to enable idempotency for export image requests.
#description ⇒ String
A description of the image being exported. The maximum length is 255 characters.
#disk_image_format ⇒ String
The disk image format.
Possible values:
- VMDK
- RAW
- VHD
#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
.
#image_id ⇒ String
The ID of the image.
#role_name ⇒ String
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named \'vmimport\'.
#s3_export_location ⇒ Types::ExportTaskS3LocationRequest
Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
#tag_specifications ⇒ Array<Types::TagSpecification>
The tags to apply to the image being exported.