ec2_create_snapshots {aws.ecx}

Create Snapshots

Description

Create Snapshots

Usage

ec2_create_snapshots(
  InstanceSpecification,
  Description = NULL,
  OutpostArn = NULL,
  TagSpecification = NULL,
  DryRun = NULL,
  CopyTagsFromSource = 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

InstanceSpecification

Object. The instance to specify which volumes should be included in the snapshots.

Description

Character. A description propagated to every snapshot specified by the instance.[optional]

OutpostArn

Character. The Amazon Resource Name (ARN) of the AWS Outpost on which to create the local snapshots.[optional]

TagSpecification

List. Tags to apply to every snapshot specified by the instance.[optional]

DryRun

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

CopyTagsFromSource

Character. Copies the tags from the specified volume to corresponding snapshot.[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

InstanceSpecification

The instance to specify which volumes should be included in the snapshots.

Description

A description propagated to every snapshot specified by the instance.

OutpostArn

The Amazon Resource Name (ARN) of the AWS Outpost on which to create the local snapshots.

• To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

• To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

• To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

TagSpecification

Tags to apply to every snapshot specified by the instance.

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.

CopyTagsFromSource

Copies the tags from the specified volume to corresponding snapshot.