GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::EC2::CreateImage(3) User Contributed Perl Documentation Paws::EC2::CreateImage(3)

Paws::EC2::CreateImage - Arguments for method CreateImage on Paws::EC2

This class represents the parameters used for calling the method CreateImage on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method CreateImage.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImage.

    my $ec2 = Paws->service('EC2');
# To create an AMI from an Amazon EBS-backed instance
# This example creates an AMI from the specified instance and adds an EBS volume
# with the device name /dev/sdh and an instance store volume with the device
# name /dev/sdc.
    my $CreateImageResult = $ec2->CreateImage(
      'BlockDeviceMappings' => [
        {
          'DeviceName' => '/dev/sdh',
          'Ebs'        => {
            'VolumeSize' => 100
          }
        },
        {
          'DeviceName'  => '/dev/sdc',
          'VirtualName' => 'ephemeral1'
        }
      ],
      'Description' => 'An AMI for my server',
      'InstanceId'  => 'i-1234567890abcdef0',
      'Name'        => 'My server',
      'NoReboot'    => 1
    );
    # Results:
    my $ImageId = $CreateImageResult->ImageId;
    # Returns a L<Paws::EC2::CreateImageResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateImage>

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

A description for the new image.

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

REQUIRED InstanceId => Str

The ID of the instance.

REQUIRED Name => Str

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the "No Reboot" option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

  • To tag the AMI, the value for "ResourceType" must be "image".
  • To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for "ResourceType" must be "snapshot". The same tag is applied to all of the snapshots that are created.

If you specify other values for "ResourceType", the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).

This class forms part of Paws, documenting arguments for method CreateImage in Paws::EC2

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.