R: Copy Image

ec2_copy_image {aws.ecx}

R Documentation

Copy Image

Description

Copy Image

Usage

ec2_copy_image(
  Name,
  SourceImageId,
  SourceRegion,
  ClientToken = NULL,
  Description = NULL,
  Encrypted = NULL,
  KmsKeyId = NULL,
  DestinationOutpostArn = NULL,
  DryRun = 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. The name of the new AMI in the destination Region.
`SourceImageId`	Character. The ID of the AMI to copy.
`SourceRegion`	Character. The name of the Region that contains the AMI to copy.
`ClientToken`	Character. Unique, case-sensitive identifier you provide to ensure idempotency of the request.[optional]
`Description`	Character. A description for the new AMI in the destination Region.[optional]
`Encrypted`	Logical. Specifies whether the destination snapshots of the copied image should be encrypted.[optional]
`KmsKeyId`	Character. The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK)...[optional]
`DestinationOutpostArn`	Character. The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI.[optional]
`DryRun`	Logical. Checks whether you have the required permissions for the action, without actually making the request,...[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

The name of the new AMI in the destination Region.

SourceImageId

The ID of the AMI to copy.

SourceRegion

The name of the Region that contains the AMI to copy.

ClientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Description

A description for the new AMI in the destination Region.

Encrypted

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

KmsKeyId

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK using any of the following:

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

DestinationOutpostArn

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

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.

[Package aws.ecx version 1.0.5 Index]