Class: Aws::Neptune::Types::DescribeDBClusterEndpointsMessage

Inherits:

Struct

• Object
• Struct
• Aws::Neptune::Types::DescribeDBClusterEndpointsMessage

Includes:

Structure

Defined in:

lib/aws-sdk-neptune/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 3843

class DescribeDBClusterEndpointsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_endpoint_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 3843

class DescribeDBClusterEndpointsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_endpoint_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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`, `inactive`, `modifying`.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-neptune/types.rb', line 3843

class DescribeDBClusterEndpointsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_endpoint_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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`.

Returns:

• (String)

# File 'lib/aws-sdk-neptune/types.rb', line 3843

class DescribeDBClusterEndpointsMessage < Struct.new(
  :db_cluster_identifier,
  :db_cluster_endpoint_identifier,
  :filters,
  :max_records,
  :marker)
  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)

# File 'lib/aws-sdk-neptune/types.rb', line 3843

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