ec2_register_image {aws.ecx}

Register Image

Description

Register Image

Usage

ec2_register_image(
  Name,
  ImageLocation = NULL,
  Architecture = NULL,
  BlockDeviceMapping = NULL,
  Description = NULL,
  DryRun = NULL,
  EnaSupport = NULL,
  KernelId = NULL,
  BillingProduct = NULL,
  RamdiskId = NULL,
  RootDeviceName = NULL,
  SriovNetSupport = NULL,
  VirtualizationType = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Name

Character. A name for your AMI.

ImageLocation

Character. The full path to your AMI manifest in Amazon S3 storage.[optional]

Architecture

Character. The architecture of the AMI.[optional]

BlockDeviceMapping

List. The block device mapping entries.[optional]

Description

Character. A description for your AMI.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

EnaSupport

Logical. Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch...[optional]

KernelId

Character. The ID of the kernel.[optional]

BillingProduct

List. The billing product codes.[optional]

RamdiskId

Character. The ID of the RAM disk.[optional]

RootDeviceName

Character. The device name of the root device volume (for example, ⁠/dev/sda1⁠).[optional]

SriovNetSupport

Character. Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for...[optional]

VirtualizationType

Character. The type of virtualization (hvm \| paravirtual). Default: paravirtual [optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

Name

A name for your AMI.

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

ImageLocation

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

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.

BlockDeviceMapping

The block device mapping entries.

If you specify an EBS volume using the ID of an EBS snapshot, you can\'t specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

Description

A description for your AMI.

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.

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.

KernelId

The ID of the kernel.

BillingProduct

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.

RamdiskId

The ID of the RAM disk.

RootDeviceName

The device name of the root device volume (for example, ⁠/dev/sda1⁠).

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.

VirtualizationType

The type of virtualization (hvm \| paravirtual).

Default: paravirtual