Amazon RDS Rds Db Proxy Endpoint API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Proxy Endpoint API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 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: []
tags:
- name: Db Proxy Endpoint
paths:
  /?Action=CreateDBProxyEndpoint:
    post:
      operationId: CreateDBProxyEndpoint
      summary: Create DBProxy Endpoint
      description: Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBProxyEndpointResponse'
        '400':
          description: DBProxyEndpointAlreadyExistsFault; DBProxyEndpointQuotaExceededFault; InvalidDBProxyStateFault; InvalidSubnet
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyEndpointAlreadyExistsFault'
        '404':
          description: DBProxyNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBProxyEndpoint
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBProxyEndpointRequest'
      tags:
      - Db Proxy Endpoint
  /?Action=DeleteDBProxyEndpoint:
    post:
      operationId: DeleteDBProxyEndpoint
      summary: Delete DBProxy Endpoint
      description: Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteDBProxyEndpointResponse'
        '404':
          description: DBProxyEndpointNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyEndpointNotFoundFault'
        '400':
          description: InvalidDBProxyEndpointStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBProxyEndpointStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDBProxyEndpoint
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBProxyEndpointRequest'
      tags:
      - Db Proxy Endpoint
  /?Action=DescribeDBProxyEndpoints:
    post:
      operationId: DescribeDBProxyEndpoints
      summary: Describe DBProxy Endpoints
      description: Returns information about DB proxy endpoints.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeDBProxyEndpointsResponse'
        '404':
          description: DBProxyEndpointNotFoundFault; DBProxyNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyEndpointNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBProxyEndpoints
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBProxyEndpointsRequest'
      tags:
      - Db Proxy Endpoint
  /?Action=ModifyDBProxyEndpoint:
    post:
      operationId: ModifyDBProxyEndpoint
      summary: Modify DBProxy Endpoint
      description: Changes the settings for an existing DB proxy endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyDBProxyEndpointResponse'
        '400':
          description: DBProxyEndpointAlreadyExistsFault; InvalidDBProxyEndpointStateFault; InvalidDBProxyStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyEndpointAlreadyExistsFault'
        '404':
          description: DBProxyEndpointNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyEndpointNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyDBProxyEndpoint
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBProxyEndpointRequest'
      tags:
      - Db Proxy Endpoint
components:
  schemas:
    DBProxyNotFoundFault:
      type: object
      properties:
        message:
          type: string
    CreateDBProxyEndpointRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The name of the DB proxy associated with the DB proxy endpoint that you create.
        DBProxyEndpointName:
          type: string
          description: The name of the DB proxy endpoint to create.
        VpcSubnetIds:
          type: array
          items:
            type: string
          description: The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
        TargetRole:
          type: string
          enum:
          - READ_WRITE
          - READ_ONLY
          description: The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        EndpointNetworkType:
          type: string
          enum:
          - IPV4
          - IPV6
          - DUAL
          description: 'The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: IPV4 - The proxy endpoint supports IPv4 only. IPV6 - The proxy endpoint supports IPv6 only. DUAL - The proxy endpoint supports both IPv4 and IPv6. Default: IPV4 Constraints: If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block. If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.'
      required:
      - DBProxyName
      - DBProxyEndpointName
      - VpcSubnetIds
    ModifyDBProxyEndpointRequest:
      type: object
      properties:
        DBProxyEndpointName:
          type: string
          description: The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
        NewDBProxyEndpointName:
          type: string
          description: The new identifier for the DBProxyEndpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
      required:
      - DBProxyEndpointName
    DBProxyEndpoint:
      type: object
      properties:
        DBProxyEndpointName:
          type: string
          description: The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
        DBProxyEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB proxy endpoint.
        DBProxyName:
          type: string
          description: The identifier for the DB proxy that is associated with this DB proxy endpoint.
        Status:
          type: string
          enum:
          - available
          - modifying
          - incompatible-network
          - insufficient-resource-limits
          - creating
          - deleting
          description: The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
        VpcId:
          type: string
          description: Provides the VPC ID of the DB proxy endpoint.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: Provides a list of VPC security groups that the DB proxy endpoint belongs to.
        VpcSubnetIds:
          type: array
          items:
            type: string
          description: The EC2 subnet IDs for the DB proxy endpoint.
        Endpoint:
          type: string
          description: The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
        CreatedDate:
          type: string
          format: date-time
          description: The date and time when the DB proxy endpoint was first created.
        TargetRole:
          type: string
          enum:
          - READ_WRITE
          - READ_ONLY
          description: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
        IsDefault:
          type: boolean
          description: Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
        EndpointNetworkType:
          type: string
          enum:
          - IPV4
          - IPV6
          - DUAL
          description: 'The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: IPV4 - The proxy endpoint supports IPv4 only. IPV6 - The proxy endpoint supports IPv6 only. DUAL - The proxy endpoint supports both IPv4 and IPv6.'
    DescribeDBProxyEndpointsResponse:
      type: object
      properties:
        DBProxyEndpoints:
          type: array
          items:
            $ref: '#/components/schemas/DBProxyEndpoint'
          description: The list of ProxyEndpoint objects returned by the API operation.
        Marker:
          type: string
          description: An optional pagination token provided by a previous 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: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: One or more filter values. Filter values are case-sensitive.
      required:
      - Name
      - Values
    ModifyDBProxyEndpointResponse:
      type: object
      properties:
        DBProxyEndpoint:
          $ref: '#/components/schemas/DBProxyEndpoint'
    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 only 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 only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").'
    DBProxyEndpointNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DeleteDBProxyEndpointResponse:
      type: object
      properties:
        DBProxyEndpoint:
          $ref: '#/components/schemas/DBProxyEndpoint'
    InvalidDBProxyEndpointStateFault:
      type: object
      properties:
        message:
          type: string
    DeleteDBProxyEndpointRequest:
      type: object
      properties:
        DBProxyEndpointName:
          type: string
          description: The name of the DB proxy endpoint to delete.
      required:
      - DBProxyEndpointName
    CreateDBProxyEndpointResponse:
      type: object
      properties:
        DBProxyEndpoint:
          $ref: '#/components/schemas/DBProxyEndpoint'
    DBProxyEndpointAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DescribeDBProxyEndpointsRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
        DBProxyEndpointName:
          type: string
          description: The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter is not currently supported.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        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 that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.'
  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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/rds/service/2014-10-31/rds-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)