Class: Aws::RDS::Types::DescribeDBClusterSnapshotsMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/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,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifier ⇒ String

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the ‘DBClusterSnapshotIdentifier` parameter. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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

#db_cluster_snapshot_identifier ⇒ String

A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the ‘DBClusterIdentifier` parameter. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

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

Returns:

  • (String) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:



5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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

#include_public ⇒ Boolean

Set this value to ‘true` to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to `false`. The default is `false`. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Returns:

  • (Boolean) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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

#include_shared ⇒ Boolean

Set this value to ‘true` to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to `false`. The default is `false`.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

Returns:

  • (Boolean) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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

#marker ⇒ String

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

Returns:

  • (String) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

class DescribeDBClusterSnapshotsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_snapshot_identifier,
  :snapshot_type,
  :filters,
  :max_records,
  :marker,
  :include_shared,
  :include_public)
  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 called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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

#snapshot_type ⇒ String

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

  • ‘automated` - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • ‘manual` - Return all DB cluster snapshots that have been taken by my AWS account.

  • ‘shared` - Return all manual DB cluster snapshots that have been shared to my AWS account.

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

If you don’t specify a ‘SnapshotType` value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the `IncludeShared` parameter to `true`. You can include public DB 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) 


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/aws-sdk-rds/types.rb', line 5851

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