Documentation

This data type represents the information you need to connect to an Amazon Neptune 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 Neptune DB instance endpoints, see Endpoint.

See: newDBClusterEndpoint smart constructor.

Create a value of DBClusterEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DBClusterEndpoint', dbClusterEndpoint_status - The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

$sel:dbClusterIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

$sel:dbClusterEndpointArn:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointArn - The Amazon Resource Name (ARN) for the endpoint.

$sel:customEndpointType:DBClusterEndpoint', dbClusterEndpoint_customEndpointType - The type associated with a custom endpoint. One of: READER, WRITER, ANY.

$sel:staticMembers:DBClusterEndpoint', dbClusterEndpoint_staticMembers - List of DB instance identifiers that are part of the custom endpoint group.

$sel:endpointType:DBClusterEndpoint', dbClusterEndpoint_endpointType - The type of the endpoint. One of: READER, WRITER, CUSTOM.

$sel:dbClusterEndpointIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointIdentifier - The identifier associated with the endpoint. This parameter is stored as a lowercase string.

$sel:endpoint:DBClusterEndpoint', dbClusterEndpoint_endpoint - The DNS address of the endpoint.

$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointResourceIdentifier - A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

$sel:excludedMembers:DBClusterEndpoint', dbClusterEndpoint_excludedMembers - 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.

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

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

The Amazon Resource Name (ARN) for the endpoint.

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

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

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

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

The DNS address of the endpoint.

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

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.