You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::CopySnapshotRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::CopySnapshotRequest
- Defined in:
- (unknown)
Overview
When passing CopySnapshotRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
source_snapshot_name: "ResourceName",
source_resource_name: "string",
restore_date: "string",
use_latest_restorable_auto_snapshot: false,
target_snapshot_name: "ResourceName", # required
source_region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2
}
Instance Attribute Summary collapse
-
#restore_date ⇒ String
The date of the source automatic snapshot to copy.
-
#source_region ⇒ String
The AWS Region where the source manual or automatic snapshot is located.
-
#source_resource_name ⇒ String
The name of the source instance or disk from which the source automatic snapshot was created.
-
#source_snapshot_name ⇒ String
The name of the source manual snapshot to copy.
-
#target_snapshot_name ⇒ String
The name of the new manual snapshot to be created as a copy.
-
#use_latest_restorable_auto_snapshot ⇒ Boolean
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Instance Attribute Details
#restore_date ⇒ String
The date of the source automatic snapshot to copy. Use the get auto
snapshots
operation to identify the dates of the available automatic
snapshots.
Constraints:
Must be specified in
YYYY-MM-DD
format.This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive.Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
#source_region ⇒ String
The AWS Region where the source manual or automatic snapshot is located.
Possible values:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- ca-central-1
- ap-south-1
- ap-southeast-1
- ap-southeast-2
- ap-northeast-1
- ap-northeast-2
#source_resource_name ⇒ String
The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
- Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
^
#source_snapshot_name ⇒ String
The name of the source manual snapshot to copy.
Constraint:
- Define this parameter only when copying a manual snapshot as another manual snapshot.
^
#target_snapshot_name ⇒ String
The name of the new manual snapshot to be created as a copy.
#use_latest_restorable_auto_snapshot ⇒ Boolean
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive.Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.