Amazon Relational Database Service
API Reference (API Version 2014-10-31)

ModifyDBClusterEndpoint

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterEndpointIdentifier

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

Type: String

Required: Yes

EndpointType

The type of the endpoint. One of: READER, ANY.

Type: String

Required: No

ExcludedMembers.member.N

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.

Type: Array of strings

Required: No

StaticMembers.member.N

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

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

CustomEndpointType

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

Type: String

DBClusterEndpointArn

The Amazon Resource Name (ARN) for the endpoint.

Type: String

DBClusterEndpointIdentifier

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

Type: String

DBClusterEndpointResourceIdentifier

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

Type: String

DBClusterIdentifier

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

Type: String

Endpoint

The DNS address of the endpoint.

Type: String

EndpointType

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

Type: String

ExcludedMembers.member.N

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.

Type: Array of strings

StaticMembers.member.N

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

Type: Array of strings

Status

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterEndpointNotFoundFault

The specified custom endpoint doesn't exist.

HTTP Status Code: 400

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

InvalidDBClusterEndpointStateFault

The requested operation can't be performed on the endpoint while the endpoint is in this state.

HTTP Status Code: 400

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: