Amazon RDS Rds Db Proxy API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Proxy 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
paths:
  /?Action=CreateDBProxy:
    post:
      operationId: CreateDBProxy
      summary: Create DBProxy
      description: Creates a new DB proxy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBProxyResponse'
        '400':
          description: DBProxyAlreadyExistsFault; DBProxyQuotaExceededFault; InvalidSubnet
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBProxy
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBProxyRequest'
      tags:
      - Db Proxy
  /?Action=DeleteDBProxy:
    post:
      operationId: DeleteDBProxy
      summary: Delete DBProxy
      description: Deletes an existing DB proxy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteDBProxyResponse'
        '404':
          description: DBProxyNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyNotFoundFault'
        '400':
          description: InvalidDBProxyStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBProxyStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDBProxy
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBProxyRequest'
      tags:
      - Db Proxy
  /?Action=DescribeDBProxies:
    post:
      operationId: DescribeDBProxies
      summary: Describe DBProxies
      description: Returns information about DB proxies.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeDBProxiesResponse'
        '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: DescribeDBProxies
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBProxiesRequest'
      tags:
      - Db Proxy
  /?Action=ModifyDBProxy:
    post:
      operationId: ModifyDBProxy
      summary: Modify DBProxy
      description: Changes the settings for an existing DB proxy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyDBProxyResponse'
        '400':
          description: DBProxyAlreadyExistsFault; InvalidDBProxyStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBProxyAlreadyExistsFault'
        '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: ModifyDBProxy
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBProxyRequest'
      tags:
      - Db Proxy
components:
  schemas:
    ModifyDBProxyRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The identifier for the DBProxy to modify.
        NewDBProxyName:
          type: string
          description: The new identifier for the DBProxy. 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.
        DefaultAuthScheme:
          type: string
          enum:
          - IAM_AUTH
          - NONE
          description: The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
        Auth:
          type: array
          items:
            $ref: '#/components/schemas/UserAuthConfig'
          description: The new authentication settings for the DBProxy.
        RequireTLS:
          type: boolean
          description: Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
        IdleClientTimeout:
          type: integer
          description: The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
        DebugLogging:
          type: boolean
          description: Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
        SecurityGroups:
          type: array
          items:
            type: string
          description: The new list of security groups for the DBProxy.
      required:
      - DBProxyName
    CreateDBProxyRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. 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.
        EngineFamily:
          type: string
          enum:
          - MYSQL
          - POSTGRESQL
          - SQLSERVER
          description: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
        DefaultAuthScheme:
          type: string
          enum:
          - IAM_AUTH
          - NONE
          description: The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify DefaultAuthScheme or specify this parameter as NONE, you must specify the Auth option.
        Auth:
          type: array
          items:
            $ref: '#/components/schemas/UserAuthConfig'
          description: The authorization mechanism that the proxy uses.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
        VpcSubnetIds:
          type: array
          items:
            type: string
          description: One or more VPC subnet IDs to associate with the new proxy.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: One or more VPC security group IDs to associate with the new proxy.
        RequireTLS:
          type: boolean
          description: Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
        IdleClientTimeout:
          type: integer
          description: The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
        DebugLogging:
          type: boolean
          description: Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
        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.'
        TargetConnectionNetworkType:
          type: string
          enum:
          - IPV4
          - IPV6
          description: 'The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database. Valid values: IPV4 - The proxy connects to the database using IPv4 only. IPV6 - The proxy connects to the database using IPv6 only. Default: IPV4 Constraints: If you specify IPV6, the database must support dual-stack mode. RDS doesn''t support IPv6-only databases. All targets registered with the proxy must be compatible with the specified network type.'
      required:
      - DBProxyName
      - EngineFamily
      - RoleArn
      - VpcSubnetIds
    DBProxyNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DeleteDBProxyResponse:
      type: object
      properties:
        DBProxy:
          $ref: '#/components/schemas/DBProxy'
    DBProxyAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DBProxy:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
        DBProxyArn:
          type: string
          description: The Amazon Resource Name (ARN) for the proxy.
        Status:
          type: string
          enum:
          - available
          - modifying
          - incompatible-network
          - insufficient-resource-limits
          - creating
          - deleting
          - suspended
          - suspending
          - reactivating
          description: The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
        EngineFamily:
          type: string
          description: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
        VpcId:
          type: string
          description: Provides the VPC ID of the DB proxy.
        VpcSecurityGroupIds:
          type: array
          items:
            type: string
          description: Provides a list of VPC security groups that the proxy belongs to.
        VpcSubnetIds:
          type: array
          items:
            type: string
          description: The EC2 subnet IDs for the proxy.
        DefaultAuthScheme:
          type: string
          description: The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
        Auth:
          type: array
          items:
            $ref: '#/components/schemas/UserAuthConfigInfo'
          description: One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
        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.
        RequireTLS:
          type: boolean
          description: Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
        IdleClientTimeout:
          type: integer
          description: 'The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800'
        DebugLogging:
          type: boolean
          description: Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
        CreatedDate:
          type: string
          format: date-time
          description: The date and time when the proxy was first created.
        UpdatedDate:
          type: string
          format: date-time
          description: The date and time when the proxy was last updated.
        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.'
        TargetConnectionNetworkType:
          type: string
          enum:
          - IPV4
          - IPV6
          description: 'The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database. Valid values: IPV4 - The proxy connects to the database using IPv4 only. IPV6 - The proxy connects to the database using IPv6 only.'
    DescribeDBProxiesRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
        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.'
    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}_.:/=+\\-@]*)$").'
    UserAuthConfigInfo:
      type: object
      properties:
        Description:
          type: string
          description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
        UserName:
          type: string
          description: The name of the database user to which the proxy connects.
        AuthScheme:
          type: string
          enum:
          - SECRETS
          description: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
        SecretArn:
          type: string
          description: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
        IAMAuth:
          type: string
          enum:
          - DISABLED
          - REQUIRED
          - ENABLED
          description: Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
        ClientPasswordAuthType:
          type: string
          enum:
          - MYSQL_NATIVE_PASSWORD
          - MYSQL_CACHING_SHA2_PASSWORD
          - POSTGRES_SCRAM_SHA_256
          - POSTGRES_MD5
          - SQL_SERVER_AUTHENTICATION
          description: The type of authentication the proxy uses for connections from clients.
    DescribeDBProxiesResponse:
      type: object
      properties:
        DBProxies:
          type: array
          items:
            $ref: '#/components/schemas/DBProxy'
          description: A return value representing an arbitrary number of DBProxy data structures.
        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
    CreateDBProxyResponse:
      type: object
      properties:
        DBProxy:
          $ref: '#/components/schemas/DBProxy'
    ModifyDBProxyResponse:
      type: object
      properties:
        DBProxy:
          $ref: '#/components/schemas/DBProxy'
    DeleteDBProxyRequest:
      type: object
      properties:
        DBProxyName:
          type: string
          description: The name of the DB proxy to delete.
      required:
      - DBProxyName
    UserAuthConfig:
      type: object
      properties:
        Description:
          type: string
          description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
        UserName:
          type: string
          description: The name of the database user to which the proxy connects.
        AuthScheme:
          type: string
          enum:
          - SECRETS
          description: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
        SecretArn:
          type: string
          description: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
        IAMAuth:
          type: string
          enum:
          - DISABLED
          - REQUIRED
          - ENABLED
          description: A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
        ClientPasswordAuthType:
          type: string
          enum:
          - MYSQL_NATIVE_PASSWORD
          - MYSQL_CACHING_SHA2_PASSWORD
          - POSTGRES_SCRAM_SHA_256
          - POSTGRES_MD5
          - SQL_SERVER_AUTHENTICATION
          description: 'The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines: RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD RDS for SQL Server: SQL_SERVER_AUTHENTICATION RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256'
    InvalidDBProxyStateFault:
      type: object
      properties:
        message:
          type: string
  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)