Amazon Neptune Neptune Db Cluster Endpoint API

openapi: 3.1.0
info:
  title: Amazon Neptune Db Cluster Endpoint API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Neptune. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://rds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /?Action=CreateDBClusterEndpoint:
    post:
      operationId: CreateDBClusterEndpoint
      summary: Create DBCluster Endpoint
      description: Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBClusterEndpointOutput'
        '400':
          description: DBClusterEndpointAlreadyExistsFault; InvalidDBClusterStateFault; InvalidDBInstanceStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterEndpointAlreadyExistsFault'
        '403':
          description: DBClusterEndpointQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterEndpointQuotaExceededFault'
        '404':
          description: DBClusterNotFoundFault; DBInstanceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBClusterEndpoint
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBClusterEndpointMessage'
      tags:
      - Db Cluster Endpoint
  /?Action=DeleteDBClusterEndpoint:
    post:
      operationId: DeleteDBClusterEndpoint
      summary: Delete DBCluster Endpoint
      description: Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteDBClusterEndpointOutput'
        '400':
          description: DBClusterEndpointNotFoundFault; InvalidDBClusterEndpointStateFault; InvalidDBClusterStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterEndpointNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDBClusterEndpoint
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBClusterEndpointMessage'
      tags:
      - Db Cluster Endpoint
  /?Action=DescribeDBClusterEndpoints:
    post:
      operationId: DescribeDBClusterEndpoints
      summary: Describe DBCluster Endpoints
      description: Returns information about endpoints for an Amazon Neptune DB cluster. This operation can also return information
        for Amazon RDS clusters and Amazon DocDB clusters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterEndpointMessage'
        '404':
          description: DBClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBClusterEndpoints
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBClusterEndpointsMessage'
      tags:
      - Db Cluster Endpoint
  /?Action=ModifyDBClusterEndpoint:
    post:
      operationId: ModifyDBClusterEndpoint
      summary: Modify DBCluster Endpoint
      description: Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyDBClusterEndpointOutput'
        '400':
          description: DBClusterEndpointNotFoundFault; InvalidDBClusterEndpointStateFault; InvalidDBClusterStateFault; InvalidDBInstanceStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterEndpointNotFoundFault'
        '404':
          description: DBInstanceNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBInstanceNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyDBClusterEndpoint
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBClusterEndpointMessage'
      tags:
      - Db Cluster Endpoint
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: rds
  schemas:
    CreateDBClusterEndpointMessage:
      type: object
      properties:
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored
            as a lowercase string.
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
        EndpointType:
          type: string
          description: 'The type of the endpoint. One of: READER, WRITER, ANY.'
        StaticMembers:
          type: array
          items:
            type: string
          description: List of DB instance identifiers that are part of the custom endpoint group.
        ExcludedMembers:
          type: array
          items:
            type: string
          description: 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.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the Amazon Neptune resource.
      required:
      - DBClusterIdentifier
      - DBClusterEndpointIdentifier
      - EndpointType
    CreateDBClusterEndpointOutput:
      type: object
      properties:
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier associated with the endpoint. This parameter is stored as a lowercase string.
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored
            as a lowercase string.
        DBClusterEndpointResourceIdentifier:
          type: string
          description: A unique system-generated identifier for an endpoint. It remains the same for the whole life of the
            endpoint.
        Endpoint:
          type: string
          description: The DNS address of the endpoint.
        Status:
          type: string
          description: '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.'
        EndpointType:
          type: string
          description: 'The type of the endpoint. One of: READER, WRITER, CUSTOM.'
        CustomEndpointType:
          type: string
          description: 'The type associated with a custom endpoint. One of: READER, WRITER, ANY.'
        StaticMembers:
          type: array
          items:
            type: string
          description: List of DB instance identifiers that are part of the custom endpoint group.
        ExcludedMembers:
          type: array
          items:
            type: string
          description: 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.
        DBClusterEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) for the endpoint.
    DBClusterEndpoint:
      type: object
      properties:
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier associated with the endpoint. This parameter is stored as a lowercase string.
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored
            as a lowercase string.
        DBClusterEndpointResourceIdentifier:
          type: string
          description: A unique system-generated identifier for an endpoint. It remains the same for the whole life of the
            endpoint.
        Endpoint:
          type: string
          description: The DNS address of the endpoint.
        Status:
          type: string
          description: '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.'
        EndpointType:
          type: string
          description: 'The type of the endpoint. One of: READER, WRITER, CUSTOM.'
        CustomEndpointType:
          type: string
          description: 'The type associated with a custom endpoint. One of: READER, WRITER, ANY.'
        StaticMembers:
          type: array
          items:
            type: string
          description: List of DB instance identifiers that are part of the custom endpoint group.
        ExcludedMembers:
          type: array
          items:
            type: string
          description: 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.
        DBClusterEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) for the endpoint.
    DBClusterEndpointAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    DBClusterEndpointMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter
            is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        DBClusterEndpoints:
          type: array
          items:
            $ref: '#/components/schemas/DBClusterEndpoint'
          description: Contains the details of the endpoints associated with the cluster and matching any filter conditions.
    DBClusterEndpointNotFoundFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    DBClusterEndpointQuotaExceededFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    DBClusterNotFoundFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    DBInstanceNotFoundFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    DeleteDBClusterEndpointMessage:
      type: object
      properties:
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
      required:
      - DBClusterEndpointIdentifier
    DeleteDBClusterEndpointOutput:
      type: object
      properties:
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier associated with the endpoint. This parameter is stored as a lowercase string.
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored
            as a lowercase string.
        DBClusterEndpointResourceIdentifier:
          type: string
          description: A unique system-generated identifier for an endpoint. It remains the same for the whole life of the
            endpoint.
        Endpoint:
          type: string
          description: The DNS address of the endpoint.
        Status:
          type: string
          description: '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.'
        EndpointType:
          type: string
          description: 'The type of the endpoint. One of: READER, WRITER, CUSTOM.'
        CustomEndpointType:
          type: string
          description: 'The type associated with a custom endpoint. One of: READER, WRITER, ANY.'
        StaticMembers:
          type: array
          items:
            type: string
          description: List of DB instance identifiers that are part of the custom endpoint group.
        ExcludedMembers:
          type: array
          items:
            type: string
          description: 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.
        DBClusterEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) for the endpoint.
    DescribeDBClusterEndpointsMessage:
      type: object
      properties:
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored
            as a lowercase string.
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'A set of name-value pairs that define which endpoints to include in the output. The filters are specified
            as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one
            of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.
            Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type
            filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more
            of: available, '
        MaxRecords:
          type: integer
          description: 'The maximum number of records to include in the response. If more records exist than the specified
            MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining
            results. Default: 100 Constraints: Minimum 20, maximum 100.'
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter
            is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: This parameter is not currently supported.
        Values:
          type: array
          items:
            type: string
          description: This parameter is not currently supported.
      required:
      - Name
      - Values
    ModifyDBClusterEndpointMessage:
      type: object
      properties:
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
        EndpointType:
          type: string
          description: 'The type of the endpoint. One of: READER, WRITER, ANY.'
        StaticMembers:
          type: array
          items:
            type: string
          description: List of DB instance identifiers that are part of the custom endpoint group.
        ExcludedMembers:
          type: array
          items:
            type: string
          description: 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.
      required:
      - DBClusterEndpointIdentifier
    ModifyDBClusterEndpointOutput:
      type: object
      properties:
        DBClusterEndpointIdentifier:
          type: string
          description: The identifier associated with the endpoint. This parameter is stored as a lowercase string.
        DBClusterIdentifier:
          type: string
          description: The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored
            as a lowercase string.
        DBClusterEndpointResourceIdentifier:
          type: string
          description: A unique system-generated identifier for an endpoint. It remains the same for the whole life of the
            endpoint.
        Endpoint:
          type: string
          description: The DNS address of the endpoint.
        Status:
          type: string
          description: '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.'
        EndpointType:
          type: string
          description: 'The type of the endpoint. One of: READER, WRITER, CUSTOM.'
        CustomEndpointType:
          type: string
          description: 'The type associated with a custom endpoint. One of: READER, WRITER, ANY.'
        StaticMembers:
          type: array
          items:
            type: string
          description: List of DB instance identifiers that are part of the custom endpoint group.
        ExcludedMembers:
          type: array
          items:
            type: string
          description: 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.
        DBClusterEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) for the endpoint.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in
            length and can''t be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits,
            white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        Value:
          type: string
          description: 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters
            in length and can''t be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits,
            white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/neptune/service/2014-10-31/neptune-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)