Class: Aws::DocDB::Types::DescribeDBClusterSnapshotsMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::DescribeDBClusterSnapshotsMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Note:

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

{
  db_cluster_identifier: "String",
  db_cluster_snapshot_identifier: "String",
  snapshot_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
  include_shared: false,
  include_public: false,
}

Represents the input to DescribeDBClusterSnapshots.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_cluster_identifier ⇒ String

  The ID of the cluster to retrieve the list of cluster snapshots for.

• #db_cluster_snapshot_identifier ⇒ String

  A specific cluster snapshot identifier to describe.

• #filters ⇒ Array<Types::Filter>

  This parameter is not currently supported.

• #include_public ⇒ Boolean

  Set to `true` to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise `false`.

• #include_shared ⇒ Boolean

  Set to `true` to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise `false`.

• #marker ⇒ String

  An optional pagination token provided by a previous request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

• #snapshot_type ⇒ String

  The type of cluster snapshots to be returned.

Instance Attribute Details

#db_cluster_identifier ⇒ String

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the `DBClusterSnapshotIdentifier` parameter. This parameter is not case sensitive.

Constraints:

• If provided, must match the identifier of an existing `DBCluster`.

^

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_snapshot_identifier ⇒ String

A specific cluster snapshot identifier to describe. This parameter can't be used with the `DBClusterIdentifier` parameter. This value is stored as a lowercase string.

Constraints:

• If provided, must match the identifier of an existing `DBClusterSnapshot`.

• If this identifier is for an automated snapshot, the `SnapshotType` parameter must also be specified.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#include_public ⇒ Boolean

Set to `true` to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise `false`. The default is `false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#include_shared ⇒ Boolean

Set to `true` to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise `false`. The default is `false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#marker ⇒ String

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_type ⇒ String

The type of cluster snapshots to be returned. You can specify one of the following values:

• `automated` - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

• `manual` - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• `shared` - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

• `public` - Return all cluster snapshots that have been marked as public.

If you don't specify a `SnapshotType` value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the `IncludeShared` parameter to `true`. You can include public cluster snapshots with these results by setting the`IncludePublic` parameter to `true`.

The `IncludeShared` and `IncludePublic` parameters don't apply for `SnapshotType` values of `manual` or `automated`. The `IncludePublic` parameter doesn't apply when `SnapshotType` is set to `shared`. The `IncludeShared` parameter doesn't apply when `SnapshotType` is set to `public`.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3007

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  SENSITIVE = []
  include Aws::Structure
end