RegisterImage

Description

Registers an Image.

Request Parameters

  • ImageLocation - S3 Template location (not supported)

    • Required: No

    • Type: String

  • Architecture - The architecture of the image

    • Required: No

    • Type: String

    • Valid values: x86\_64

  • Name - The name of the Image

    • Type: String

    • Required: Yes

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

  • Description - A description for your image

    • Required: No

    • Type: String

  • RootDeviceName - The device name of the root device volume

    • Required: No

    • Type: String

    • Valid values: disk<N> | cdrom<N> | floppy<N> | menu

    • Default value: disk1

  • VirtualizationType - The type of virtualization

    • Required: No

    • Type: String

  • BlockDeviceMapping.n.VirtualName - Not supported

  • BlockDeviceMapping.n.DeviceName - The device name of one or more block device mapping entries

    • Required: No

    • Type: String

    • Valid values: disk<N> | cdrom<N> | floppy<N>

  • BlockDeviceMapping.n.Ebs.SnapshotId - The ID of the snapshot

    • Required: No

    • Type: String

  • BlockDeviceMapping.n.Ebs.VolumeSize - The size of the volume, in GiB

    • Required: No

    • Type: Integer

  • BlockDeviceMapping.n.Ebs.VolumeType - The type of the volume

    • Required: No

    • Type: String

    • Default value: st2

    • Valid values: st2 | gp2 | io2

  • BlockDeviceMapping.n.Ebs.Iops - The number of I/O operations per second

    • Required: No

    • Type: Integer

    • Condition: Only for io2 volume type

  • BlockDeviceMapping.n.Ebs.DeleteOnTermination - Indicates whether the EBS volume is deleted on instance termination

    • Required: No

    • Type: Boolean

Response Elements

  • imageId - The ID of the newly registered image

  • requestId - The ID of the request

Examples

c2-ec2 RegisterImage Description "<description>" <block_device_mapping>