RegisterImage#

Description#

Register an image.

Request Parameters#

Required parameters#

  • Name — The name of the image.

    • Type: String

    • Required: Yes

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

Optional parameters#

  • Architecture — The type of the image architecture.

    • Required: No

    • Type: String

    • Valid values: x86_64

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

    • Required: No

    • Type: Boolean

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

    • Required: No

    • Type: Integer

    • Restriction: For io2 disks only

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

  • Description — The description of the image.

    • Required: No

    • Type: String

  • ImageLocation — Not supported

  • RootDeviceName — The name of the root (boot) device of the instance.

    • Required: No

    • Type: String

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

    • Default value: disk1

  • VirtualizationType — The type of the image virtualization.

    • Required: No

    • Type: String

Response Elements#

  • imageId — The ID of the newly created image.

    • Type: String

  • requestId — The request ID.

    • Type: String

Examples#

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