/AWS1/CL_NEPDELDBCLUSTENDPTOUT¶
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 RDS DB instance endpoints,
see Endpoint.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_DBCLUSTERENDPOINTID TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
IV_DBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
IV_DBCLUSTERENDPTRESOURCEID TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
IV_ENDPOINT TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The DNS address of the endpoint.
IV_STATUS TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
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.
IV_ENDPOINTTYPE TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The type of the endpoint. One of:
READER,WRITER,CUSTOM.
IV_CUSTOMENDPOINTTYPE TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The type associated with a custom endpoint. One of:
READER,WRITER,ANY.
IT_STATICMEMBERS TYPE /AWS1/CL_NEPSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
List of DB instance identifiers that are part of the custom endpoint group.
IT_EXCLUDEDMEMBERS TYPE /AWS1/CL_NEPSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
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.
IV_DBCLUSTERENDPOINTARN TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING¶
The Amazon Resource Name (ARN) for the endpoint.
Queryable Attributes¶
DBClusterEndpointIdentifier¶
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBCLUSTERENDPOINTID() |
Getter for DBCLUSTERENDPOINTIDENTIFIER, with configurable de |
ASK_DBCLUSTERENDPOINTID() |
Getter for DBCLUSTERENDPOINTIDENTIFIER w/ exceptions if fiel |
HAS_DBCLUSTERENDPOINTID() |
Determine if DBCLUSTERENDPOINTIDENTIFIER has a value |
DBClusterIdentifier¶
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBCLUSTERIDENTIFIER() |
Getter for DBCLUSTERIDENTIFIER, with configurable default |
ASK_DBCLUSTERIDENTIFIER() |
Getter for DBCLUSTERIDENTIFIER w/ exceptions if field has no |
HAS_DBCLUSTERIDENTIFIER() |
Determine if DBCLUSTERIDENTIFIER has a value |
DBClusterEndpointResourceIdentifier¶
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBCLUSTERENDPTRESOURCEID() |
Getter for DBCLUSTERENDPOINTRESOURCEID, with configurable de |
ASK_DBCLUSTERENDPTRESOURCEID() |
Getter for DBCLUSTERENDPOINTRESOURCEID w/ exceptions if fiel |
HAS_DBCLUSTERENDPTRESOURCEID() |
Determine if DBCLUSTERENDPOINTRESOURCEID has a value |
Endpoint¶
The DNS address of the endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINT() |
Getter for ENDPOINT, with configurable default |
ASK_ENDPOINT() |
Getter for ENDPOINT w/ exceptions if field has no value |
HAS_ENDPOINT() |
Determine if ENDPOINT has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
EndpointType¶
The type of the endpoint. One of:
READER,WRITER,CUSTOM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINTTYPE() |
Getter for ENDPOINTTYPE, with configurable default |
ASK_ENDPOINTTYPE() |
Getter for ENDPOINTTYPE w/ exceptions if field has no value |
HAS_ENDPOINTTYPE() |
Determine if ENDPOINTTYPE has a value |
CustomEndpointType¶
The type associated with a custom endpoint. One of:
READER,WRITER,ANY.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMENDPOINTTYPE() |
Getter for CUSTOMENDPOINTTYPE, with configurable default |
ASK_CUSTOMENDPOINTTYPE() |
Getter for CUSTOMENDPOINTTYPE w/ exceptions if field has no |
HAS_CUSTOMENDPOINTTYPE() |
Determine if CUSTOMENDPOINTTYPE has a value |
StaticMembers¶
List of DB instance identifiers that are part of the custom endpoint group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATICMEMBERS() |
Getter for STATICMEMBERS, with configurable default |
ASK_STATICMEMBERS() |
Getter for STATICMEMBERS w/ exceptions if field has no value |
HAS_STATICMEMBERS() |
Determine if STATICMEMBERS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXCLUDEDMEMBERS() |
Getter for EXCLUDEDMEMBERS, with configurable default |
ASK_EXCLUDEDMEMBERS() |
Getter for EXCLUDEDMEMBERS w/ exceptions if field has no val |
HAS_EXCLUDEDMEMBERS() |
Determine if EXCLUDEDMEMBERS has a value |
DBClusterEndpointArn¶
The Amazon Resource Name (ARN) for the endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBCLUSTERENDPOINTARN() |
Getter for DBCLUSTERENDPOINTARN, with configurable default |
ASK_DBCLUSTERENDPOINTARN() |
Getter for DBCLUSTERENDPOINTARN w/ exceptions if field has n |
HAS_DBCLUSTERENDPOINTARN() |
Determine if DBCLUSTERENDPOINTARN has a value |