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 RegisterImage operation. Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. To create an AMI that must retain billing codes, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

Inheritance Hierarchy

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

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

Syntax

C#
public class RegisterImageRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The RegisterImageRequest type exposes the following members

Constructors

NameDescription
Public Method RegisterImageRequest()

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

Public Method RegisterImageRequest(string)

Instantiates RegisterImageRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Architecture Amazon.EC2.ArchitectureValues

Gets and sets the property Architecture.

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Public Property BillingProducts System.Collections.Generic.List<System.String>

Gets and sets the property BillingProducts.

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

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

Gets and sets the property BlockDeviceMappings.

One or more block device mapping entries.

Public Property Description System.String

Gets and sets the property Description.

A description for your AMI.

Public Property EnaSupport System.Boolean

Gets and sets the property EnaSupport.

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Public Property ImageLocation System.String

Gets and sets the property ImageLocation.

The full path to your AMI manifest in Amazon S3 storage.

Public Property KernelId System.String

Gets and sets the property KernelId.

The ID of the kernel.

Public Property Name System.String

Gets and sets the property Name.

A name for your AMI.

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

Public Property RamdiskId System.String

Gets and sets the property RamdiskId.

The ID of the RAM disk.

Public Property RootDeviceName System.String

Gets and sets the property RootDeviceName.

The name of the root device (for example, /dev/sda1, or /dev/xvda).

Public Property SriovNetSupport System.String

Gets and sets the property SriovNetSupport.

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Public Property VirtualizationType System.String

Gets and sets the property VirtualizationType.

The type of virtualization.

Default: paravirtual

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms