Module Values.CreateDBClusterEndpointOutputSource

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.

Sourcetype createDBClusterEndpointResult = {
  1. dBClusterEndpointIdentifier : String_.t option;
    (*

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

    *)
  2. dBClusterIdentifier : String_.t option;
    (*

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

    *)
  3. dBClusterEndpointResourceIdentifier : String_.t option;
    (*

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

    *)
  4. endpoint : String_.t option;
    (*

    The DNS address of the endpoint.

    *)
  5. status : String_.t option;
    (*

    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.

    *)
  6. endpointType : String_.t option;
    (*

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

    *)
  7. customEndpointType : String_.t option;
    (*

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

    *)
  8. staticMembers : StringList.t option;
    (*

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

    *)
  9. excludedMembers : StringList.t option;
    (*

    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.

    *)
  10. dBClusterEndpointArn : String_.t option;
    (*

    The Amazon Resource Name (ARN) for the endpoint.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. createDBClusterEndpointResult : createDBClusterEndpointResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `DBClusterEndpointAlreadyExistsFault of DBClusterEndpointAlreadyExistsFault.t
  2. | `DBClusterEndpointQuotaExceededFault of DBClusterEndpointQuotaExceededFault.t
  3. | `DBClusterNotFoundFault of DBClusterNotFoundFault.t
  4. | `DBInstanceNotFoundFault of DBInstanceNotFoundFault.t
  5. | `InvalidDBClusterStateFault of InvalidDBClusterStateFault.t
  6. | `InvalidDBInstanceStateFault of InvalidDBInstanceStateFault.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?dBClusterEndpointIdentifier:??? -> ?dBClusterIdentifier:??? -> ?dBClusterEndpointResourceIdentifier:??? -> ?endpoint:??? -> ?status:??? -> ?endpointType:??? -> ?customEndpointType:??? -> ?staticMembers:??? -> ?excludedMembers:??? -> ?dBClusterEndpointArn:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DBClusterEndpointAlreadyExistsFault of unit | `DBClusterEndpointQuotaExceededFault of unit | `DBClusterNotFoundFault of unit | `DBInstanceNotFoundFault of unit | `InvalidDBClusterStateFault of unit | `InvalidDBInstanceStateFault of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DBClusterEndpointAlreadyExistsFault of unit | `DBClusterEndpointQuotaExceededFault of unit | `DBClusterNotFoundFault of unit | `DBInstanceNotFoundFault of unit | `InvalidDBClusterStateFault of unit | `InvalidDBInstanceStateFault of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `List of [> `String of String_.t ] list | `String of String_.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t