CreateImageRequest Class | AWS SDK for .NET Version 4

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 Create an Amazon EBS-backed 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. When using the CreateImage action: You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance. You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action. The only option that can be changed for existing mappings or snapshots is `DeleteOnTermination`. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Description	System.String	Gets and sets the property Description. A description for the new image.
DryRun	System.Nullable<System.Boolean>	Gets and sets the property DryRun. 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`.
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.Nullable<System.Boolean>	Gets and sets the property NoReboot. Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values: `true` - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots. `false` - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created. Default: `false`
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer