ec2_create_image {aws.ecx}

Create Image

Description

Create Image

Usage

ec2_create_image(
  InstanceId,
  Name,
  BlockDeviceMapping = NULL,
  Description = NULL,
  DryRun = NULL,
  NoReboot = NULL,
  TagSpecification = 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

InstanceId

Character. The ID of the instance.

Name

Character. A name for the new image.

BlockDeviceMapping

List. The block device mappings.[optional]

Description

Character. A description for the new image.[optional]

DryRun

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

NoReboot

Logical. By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.[optional]

TagSpecification

List. The tags to apply to the AMI and snapshots on creation.[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

InstanceId

The ID of the instance.

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(_)

BlockDeviceMapping

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

A description for the new image.

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.

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. When this option is used, file system integrity on the created image can\'t be guaranteed.

TagSpecification

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