Class: Aws::Redshift::Types::DescribeClusterSnapshotsMessage

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

Overview

Note:

When making an API call, you may pass DescribeClusterSnapshotsMessage data as a hash:

{
  cluster_identifier: "String",
  snapshot_identifier: "String",
  snapshot_type: "String",
  start_time: Time.now,
  end_time: Time.now,
  max_records: 1,
  marker: "String",
  owner_account: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
  cluster_exists: false,
  sorting_entities: [
    {
      attribute: "SOURCE_TYPE", # required, accepts SOURCE_TYPE, TOTAL_SIZE, CREATE_TIME
      sort_order: "ASC", # accepts ASC, DESC
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_existsBoolean

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

  • If ClusterExists is set to true, ClusterIdentifier is required.

  • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

Returns:

  • (Boolean)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifierString

The identifier of the cluster which generated the requested snapshots.

Returns:

  • (String)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Returns:

  • (Time)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (String)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Returns:

  • (Integer)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#owner_accountString

The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

Returns:

  • (String)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_identifierString

The snapshot identifier of the snapshot about which to return information.

Returns:

  • (String)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_typeString

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

Returns:

  • (String)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#sorting_entitiesArray<Types::SnapshotSortingEntity>

Returns:



4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Returns:

  • (Time)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#tag_keysArray<String>

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

Returns:

  • (Array<String>)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end

#tag_valuesArray<String>

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Returns:

  • (Array<String>)


4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4289

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values,
  :cluster_exists,
  :sorting_entities)
  SENSITIVE = []
  include Aws::Structure
end