Class: Aws::RDS::Types::DescribeDBClusterEndpointsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DescribeDBClusterEndpointsMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
When making an API call, you may pass DescribeDBClusterEndpointsMessage data as a hash:
{
db_cluster_identifier: "String",
db_cluster_endpoint_identifier: "String",
filters: [
{
name: "String", # required
values: ["String"], # required
},
],
max_records: 1,
marker: "String",
}
Instance Attribute Summary collapse
-
#db_cluster_endpoint_identifier ⇒ String
The identifier of the endpoint to describe.
-
#db_cluster_identifier ⇒ String
The DB cluster identifier of the DB cluster associated with the endpoint.
-
#filters ⇒ Array<Types::Filter>
A set of name-value pairs that define which endpoints to include in the output.
-
#marker ⇒ String
An optional pagination token provided by a previous DescribeDBClusterEndpoints request.
-
#max_records ⇒ Integer
The maximum number of records to include in the response.
Instance Attribute Details
#db_cluster_endpoint_identifier ⇒ String
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
6759 6760 6761 6762 6763 6764 6765 6766 |
# File 'lib/aws-sdk-rds/types.rb', line 6759 class DescribeDBClusterEndpointsMessage < Struct.new( :db_cluster_identifier, :db_cluster_endpoint_identifier, :filters, :max_records, :marker) include Aws::Structure end |
#db_cluster_identifier ⇒ String
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
6759 6760 6761 6762 6763 6764 6765 6766 |
# File 'lib/aws-sdk-rds/types.rb', line 6759 class DescribeDBClusterEndpointsMessage < Struct.new( :db_cluster_identifier, :db_cluster_endpoint_identifier, :filters, :max_records, :marker) include Aws::Structure end |
#filters ⇒ Array<Types::Filter>
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format ‘Name=endpoint_type,Values=endpoint_type1,endpoint_type2,…`. `Name` can be one of: `db-cluster-endpoint-type`, `db-cluster-endpoint-custom-type`, `db-cluster-endpoint-id`, `db-cluster-endpoint-status`. `Values` for the ` db-cluster-endpoint-type` filter can be one or more of: `reader`, `writer`, `custom`. `Values` for the `db-cluster-endpoint-custom-type` filter can be one or more of: `reader`, `any`. `Values` for the `db-cluster-endpoint-status` filter can be one or more of: `available`, `creating`, `deleting`, `modifying`.
6759 6760 6761 6762 6763 6764 6765 6766 |
# File 'lib/aws-sdk-rds/types.rb', line 6759 class DescribeDBClusterEndpointsMessage < Struct.new( :db_cluster_identifier, :db_cluster_endpoint_identifier, :filters, :max_records, :marker) include Aws::Structure end |
#marker ⇒ String
An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.
6759 6760 6761 6762 6763 6764 6765 6766 |
# File 'lib/aws-sdk-rds/types.rb', line 6759 class DescribeDBClusterEndpointsMessage < Struct.new( :db_cluster_identifier, :db_cluster_endpoint_identifier, :filters, :max_records, :marker) 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.
6759 6760 6761 6762 6763 6764 6765 6766 |
# File 'lib/aws-sdk-rds/types.rb', line 6759 class DescribeDBClusterEndpointsMessage < Struct.new( :db_cluster_identifier, :db_cluster_endpoint_identifier, :filters, :max_records, :marker) include Aws::Structure end |