You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::DescribeDBClusterEndpointsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeDBClusterEndpointsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_cluster_identifier: "String",
  db_cluster_endpoint_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_endpoint_identifier ⇒ String

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

Returns:

  • (String) —

    The identifier of the endpoint to describe.

#db_cluster_identifier ⇒ String

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Returns:

  • (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. 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, inactive, modifying.

Returns:

  • (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. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (String) —

    An optional pagination token provided by a previous DescribeDBClusterEndpoints request.

#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) —

    The maximum number of records to include in the response.