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

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::DescribeClusterSnapshotsMessage

Defined in:

gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_exists ⇒ Boolean

  A value that indicates whether to return snapshots only for an existing cluster.

• #cluster_identifier ⇒ String

  The identifier of the cluster which generated the requested snapshots.

• #end_time ⇒ Time

  A time value that requests only snapshots created at or before the specified time.

• #marker ⇒ String

  An optional parameter that specifies the starting point to return a set of response records.

• #max_records ⇒ Integer

  The maximum number of response records to return in each call.

• #owner_account ⇒ String

  The Amazon Web Services account used to create or copy the snapshot.

• #snapshot_arn ⇒ String

  The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

• #snapshot_identifier ⇒ String

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

• #snapshot_type ⇒ String

  The type of snapshots for which you are requesting information.

• #sorting_entities ⇒ Array<Types::SnapshotSortingEntity>
• #start_time ⇒ Time

  A value that requests only snapshots created at or after the specified time.

• #tag_keys ⇒ Array<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.

• #tag_values ⇒ Array<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.

Instance Attribute Details

#cluster_exists ⇒ Boolean

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)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_identifier ⇒ String

The identifier of the cluster which generated the requested snapshots.

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_time ⇒ Time

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)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

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

#marker ⇒ String

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)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_records ⇒ Integer

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)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_account ⇒ String

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)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_arn ⇒ String

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_identifier ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_type ⇒ String

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

Valid Values: automated | manual

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_entities ⇒ Array<Types::SnapshotSortingEntity>

Returns:

• (Array<Types::SnapshotSortingEntity>)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_time ⇒ Time

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)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_keys ⇒ Array<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>)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_arn,
  :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_values ⇒ Array<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>)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4291

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