Class: Aws::Lightsail::Types::CopySnapshotRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass CopySnapshotRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#restore_dateString

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. 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)


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1110

class CopySnapshotRequest < Struct.new(
  :source_snapshot_name,
  :source_resource_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot,
  :target_snapshot_name,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_regionString

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

Returns:

  • (String)


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1110

class CopySnapshotRequest < Struct.new(
  :source_snapshot_name,
  :source_resource_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot,
  :target_snapshot_name,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_resource_nameString

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.

^

Returns:

  • (String)


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1110

class CopySnapshotRequest < Struct.new(
  :source_snapshot_name,
  :source_resource_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot,
  :target_snapshot_name,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_snapshot_nameString

The name of the source manual snapshot to copy.

Constraint:

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

^

Returns:

  • (String)


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1110

class CopySnapshotRequest < Struct.new(
  :source_snapshot_name,
  :source_resource_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot,
  :target_snapshot_name,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#target_snapshot_nameString

The name of the new manual snapshot to be created as a copy.

Returns:

  • (String)


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1110

class CopySnapshotRequest < Struct.new(
  :source_snapshot_name,
  :source_resource_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot,
  :target_snapshot_name,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#use_latest_restorable_auto_snapshotBoolean

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. 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)


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1110

class CopySnapshotRequest < Struct.new(
  :source_snapshot_name,
  :source_resource_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot,
  :target_snapshot_name,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end