CreateDBClusterEndpoint
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterEndpointIdentifier
-
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
Type: String
Required: Yes
- DBClusterIdentifier
-
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
Type: String
Required: Yes
- EndpointType
-
The type of the endpoint. One of:
READER,WRITER,ANY.Type: String
Required: Yes
- 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
- Tags.Tag.N
-
The tags to be assigned to the Amazon Neptune resource.
Type: Array of Tag objects
Required: No
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 cannot 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.
- DBClusterEndpointAlreadyExistsFault
-
The specified custom endpoint cannot be created because it already exists.
HTTP Status Code: 400
- DBClusterEndpointQuotaExceededFault
-
The cluster already has the maximum number of custom endpoints.
HTTP Status Code: 403
- DBClusterNotFoundFault
-
DBClusterIdentifier does not refer to an existing DB cluster.
HTTP Status Code: 404
- DBInstanceNotFound
-
DBInstanceIdentifier does not refer to an existing DB instance.
HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The DB cluster is not in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified DB instance is not in the available 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:
