Class: Aws::RDS::Types::DescribeDBClustersMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifier ⇒ String

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn’t case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

^

Returns:

  • (String) 


10800
10801
10802
10803
10804
10805
10806
10807
10808
 
# File 'lib/aws-sdk-rds/types.rb', line 10800

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

#filters ⇒ Array<Types::Filter>

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • ‘clone-group-id` - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

  • ‘db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

  • ‘db-cluster-resource-id` - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

  • ‘domain` - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

  • ‘engine` - Accepts engine names. The results list only includes information about the DB clusters for these engines.

Returns:



10800
10801
10802
10803
10804
10805
10806
10807
10808
 
# File 'lib/aws-sdk-rds/types.rb', line 10800

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

#include_shared ⇒ Boolean

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

Returns:

  • (Boolean) 


10800
10801
10802
10803
10804
10805
10806
10807
10808
 
# File 'lib/aws-sdk-rds/types.rb', line 10800

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

#marker ⇒ String

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

Returns:

  • (String) 


10800
10801
10802
10803
10804
10805
10806
10807
10808
 
# File 'lib/aws-sdk-rds/types.rb', line 10800

class DescribeDBClustersMessage < Struct.new(
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker,
  :include_shared)
  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 called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) 


10800
10801
10802
10803
10804
10805
10806
10807
10808
 
# File 'lib/aws-sdk-rds/types.rb', line 10800

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