AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateImage operation. Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CreateImageRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateImageRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateImageRequest type exposes the following members

Constructors

NameDescription
Public Method CreateImageRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateImageRequest(string, string)

Instantiates CreateImageRequest with the parameterized properties

Properties

NameTypeDescription
Public Property BlockDeviceMappings System.Collections.Generic.List<Amazon.EC2.Model.BlockDeviceMapping>

Gets and sets the property BlockDeviceMappings.

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.

Public Property Description System.String

Gets and sets the property Description.

A description for the new image.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the instance.

Public Property Name System.String

Gets and sets the property Name.

A name for the new image.

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

Public Property NoReboot System.Boolean

Gets and sets the property NoReboot.

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. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted at the same time), but not application consistent (all the operating system buffers are not flushed to disk before the snapshots are created).

Public Property TagSpecifications System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>

Gets and sets the property TagSpecifications.

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

Examples

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.

To create an AMI from an Amazon EBS-backed instance


var client = new AmazonEC2Client();
var response = client.CreateImage(new CreateImageRequest 
{
    BlockDeviceMappings = new List<BlockDeviceMapping> {
        new BlockDeviceMapping {
            DeviceName = "/dev/sdh",
            Ebs = new EbsBlockDevice { VolumeSize = 100 }
        },
        new BlockDeviceMapping {
            DeviceName = "/dev/sdc",
            VirtualName = "ephemeral1"
        }
    },
    Description = "An AMI for my server",
    InstanceId = "i-1234567890abcdef0",
    Name = "My server",
    NoReboot = true
});

string imageId = response.ImageId;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5