CreateImageRequest Class | AWS SDK for .NET V3

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.

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.

If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can't guarantee the file system integrity of the created image.

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 Create an Amazon EBS-backed Linux AMI 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

public class CreateImageRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateImageRequest type exposes the following members

Constructors

	Name	Description
	CreateImageRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	CreateImageRequest(string, string)	Instantiates CreateImageRequest with the parameterized properties

Properties

Name	Type	Description
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.
Description	System.String	Gets and sets the property Description. A description for the new image.
InstanceId	System.String	Gets and sets the property InstanceId. The ID of the instance.
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(_)
NoReboot	System.Boolean	Gets and sets the property NoReboot. By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the `NoReboot` parameter to `true` in the API request, or use the `--no-reboot` option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance. If you choose to bypass the shutdown and reboot process by setting the `NoReboot` parameter to `true` in the API request, or by using the `--no-reboot` option in the CLI, we can't guarantee the file system integrity of the created image. Default: `false` (follow standard reboot process)
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