Learn R Programming

paws.compute (version 0.1.12)

ec2_create_snapshots: Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3

Description

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.

Usage

ec2_create_snapshots(Description, InstanceSpecification,
  TagSpecifications, DryRun, CopyTagsFromSource)

Value

A list with the following syntax:

list(
  Snapshots = list(
    list(
      Description = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Encrypted = TRUE|FALSE,
      VolumeId = "string",
      State = "pending"|"completed"|"error",
      VolumeSize = 123,
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      Progress = "string",
      OwnerId = "string",
      SnapshotId = "string"
    )
  )
)

Arguments

Description

A description propagated to every snapshot specified by the instance.

InstanceSpecification

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

TagSpecifications

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.

Request syntax

svc$create_snapshots(
  Description = "string",
  InstanceSpecification = list(
    InstanceId = "string",
    ExcludeBootVolume = TRUE|FALSE
  ),
  TagSpecifications = list(
    list(
      ResourceType = "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"internet-gateway"|"key-pair"|"launch-template"|"local-gateway-route-table-vpc-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"placement-group"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  DryRun = TRUE|FALSE,
  CopyTagsFromSource = "volume"
)