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

Class: Aws::RDS::Types::DBClusterEndpoint

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

Overview

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_endpoint_typeString

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

Returns:

  • (String)

    The type associated with a custom endpoint.

#db_cluster_endpoint_arnString

The Amazon Resource Name (ARN) for the endpoint.

Returns:

  • (String)

    The Amazon Resource Name (ARN) for the endpoint.

#db_cluster_endpoint_identifierString

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

Returns:

  • (String)

    The identifier associated with the endpoint.

#db_cluster_endpoint_resource_identifierString

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

Returns:

  • (String)

    A unique system-generated identifier for an endpoint.

#db_cluster_identifierString

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.

#endpointString

The DNS address of the endpoint.

Returns:

  • (String)

    The DNS address of the endpoint.

#endpoint_typeString

The type of the endpoint. One of: READER, WRITER, CUSTOM.

Returns:

  • (String)

    The type of the endpoint.

#excluded_membersArray<String>

List of DB instance identifiers that aren\'t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

Returns:

  • (Array<String>)

    List of DB instance identifiers that aren\'t part of the custom endpoint group.

#static_membersArray<String>

List of DB instance identifiers that are part of the custom endpoint group.

Returns:

  • (Array<String>)

    List of DB instance identifiers that are part of the custom endpoint group.

#statusString

The current status of the endpoint. One of: creating, available, deleting, modifying.

Returns:

  • (String)

    The current status of the endpoint.