DeleteDBClusterEndpoint
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
Note
This action only applies to Aurora DB clusters.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterEndpointIdentifier
-
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- CustomEndpointType
-
The type associated with a custom endpoint. One of:
READER,WRITER,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,inactive,modifying. Theinactivestate applies to an endpoint that can't be used for a certain kind of cluster, such as awriterendpoint for a read-only secondary cluster in a global database.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
- 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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: