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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#restore_dateString

The date of the automatic snapshot to copy for the new manual snapshot.

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. The restore date and use 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.

Returns:

  • (String)

    The date of the automatic snapshot to copy for the new manual snapshot.

#source_regionString

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

Returns:

  • (String)

    The AWS Region where the source manual or automatic snapshot is located.

#source_resource_nameString

The name of the source resource from which the automatic snapshot was created.

Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

Returns:

  • (String)

    The name of the source resource from which the automatic snapshot was created.

#source_snapshot_nameString

The name of the source instance or disk snapshot to be copied.

Define this parameter only when copying a manual snapshot as another manual snapshot.

Returns:

  • (String)

    The name of the source instance or disk snapshot to be copied.

#target_snapshot_nameString

The name of the new instance or disk snapshot to be created as a copy.

Returns:

  • (String)

    The name of the new instance or disk snapshot to be created as a copy.

#use_latest_restorable_auto_snapshotBoolean

A Boolean value to indicate whether to use the latest available automatic snapshot.

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore 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.

Returns:

  • (Boolean)

    A Boolean value to indicate whether to use the latest available automatic snapshot.