Amazon RDS Rds Db Subnet Group API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Subnet Group 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 Subnet Group
paths:
  /?Action=CreateDBSubnetGroup:
    post:
      operationId: CreateDBSubnetGroup
      summary: Create DBSubnet Group
      description: Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBSubnetGroupResult'
              example:
                DBSubnetGroup:
                  DBSubnetGroupName: mysubnetgroup
                  DBSubnetGroupDescription: test DB subnet group
                  VpcId: vpc-0f08e7610a1b2c3d4
                  SubnetGroupStatus: Complete
                  Subnets:
                  - SubnetIdentifier: subnet-070dd7ecb3aaaaaaa
                    SubnetAvailabilityZone:
                      Name: us-west-2b
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-00f5b198bc0abcdef
                    SubnetAvailabilityZone:
                      Name: us-west-2d
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-0a1dc4e1a6f123456
                    SubnetAvailabilityZone:
                      Name: us-west-2b
                    SubnetStatus: Active
                  DBSubnetGroupArn: arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup
        '400':
          description: DBSubnetGroupAlreadyExistsFault; DBSubnetGroupDoesNotCoverEnoughAZs; DBSubnetGroupQuotaExceededFault; DBSubnetQuotaExceededFault; InvalidSubnet
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSubnetGroupAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBSubnetGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBSubnetGroupMessage'
            example:
              DBSubnetGroupName: mysubnetgroup
              DBSubnetGroupDescription: test DB subnet group
              SubnetIds:
              - subnet-0a1dc4e1a6f123456
              - subnet-070dd7ecb3aaaaaaa
              - subnet-00f5b198bc0abcdef
      tags:
      - Db Subnet Group
  /?Action=DeleteDBSubnetGroup:
    post:
      operationId: DeleteDBSubnetGroup
      summary: Delete DBSubnet Group
      description: Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: DBSubnetGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSubnetGroupNotFoundFault'
        '400':
          description: InvalidDBSubnetGroupStateFault; InvalidDBSubnetStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBSubnetGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDBSubnetGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBSubnetGroupMessage'
            example:
              DBSubnetGroupName: mysubnetgroup
      tags:
      - Db Subnet Group
  /?Action=DescribeDBSubnetGroups:
    post:
      operationId: DescribeDBSubnetGroups
      summary: Describe DBSubnet Groups
      description: Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSubnetGroupMessage'
              example:
                DBSubnetGroups:
                - DBSubnetGroupName: mydbsubnetgroup
                  DBSubnetGroupDescription: My DB Subnet Group
                  VpcId: vpc-971c12ee
                  SubnetGroupStatus: Complete
                  Subnets:
                  - SubnetIdentifier: subnet-d8c8e7f4
                    SubnetAvailabilityZone:
                      Name: us-east-1a
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-718fdc7d
                    SubnetAvailabilityZone:
                      Name: us-east-1f
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-cbc8e7e7
                    SubnetAvailabilityZone:
                      Name: us-east-1a
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-0ccde220
                    SubnetAvailabilityZone:
                      Name: us-east-1a
                    SubnetStatus: Active
                  DBSubnetGroupArn: arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup
        '404':
          description: DBSubnetGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSubnetGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBSubnetGroups
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBSubnetGroupsMessage'
      tags:
      - Db Subnet Group
  /?Action=ModifyDBSubnetGroup:
    post:
      operationId: ModifyDBSubnetGroup
      summary: Modify DBSubnet Group
      description: Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyDBSubnetGroupResult'
              example:
                DBSubnetGroup:
                  DBSubnetGroupName: mysubnetgroup
                  DBSubnetGroupDescription: test DB subnet group
                  VpcId: vpc-0f08e7610a1b2c3d4
                  SubnetGroupStatus: Complete
                  Subnets:
                  - SubnetIdentifier: subnet-08e41f9e230222222
                    SubnetAvailabilityZone:
                      Name: us-west-2a
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-070dd7ecb3aaaaaaa
                    SubnetAvailabilityZone:
                      Name: us-west-2b
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-00f5b198bc0abcdef
                    SubnetAvailabilityZone:
                      Name: us-west-2d
                    SubnetStatus: Active
                  - SubnetIdentifier: subnet-0a1dc4e1a6f123456
                    SubnetAvailabilityZone:
                      Name: us-west-2b
                    SubnetStatus: Active
                  DBSubnetGroupArn: arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup
        '400':
          description: DBSubnetGroupDoesNotCoverEnoughAZs; DBSubnetQuotaExceededFault; InvalidDBSubnetGroupStateFault; InvalidSubnet; SubnetAlreadyInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSubnetGroupDoesNotCoverEnoughAZs'
        '404':
          description: DBSubnetGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBSubnetGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyDBSubnetGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBSubnetGroupMessage'
            example:
              DBSubnetGroupName: mysubnetgroup
              DBSubnetGroupDescription: ''
              SubnetIds:
              - subnet-0a1dc4e1a6f123456
              - subnet-070dd7ecb3aaaaaaa
              - subnet-00f5b198bc0abcdef
              - subnet-08e41f9e230222222
      tags:
      - Db Subnet Group
components:
  schemas:
    CreateDBSubnetGroupResult:
      type: object
      properties:
        DBSubnetGroup:
          $ref: '#/components/schemas/DBSubnetGroup'
    Outpost:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Outpost.
    Subnet:
      type: object
      properties:
        SubnetIdentifier:
          type: string
          description: The identifier of the subnet.
        SubnetAvailabilityZone:
          $ref: '#/components/schemas/AvailabilityZone'
        SubnetOutpost:
          $ref: '#/components/schemas/Outpost'
        SubnetStatus:
          type: string
          description: The status of the subnet.
    DescribeDBSubnetGroupsMessage:
      type: object
      properties:
        DBSubnetGroupName:
          type: string
          description: The name of the DB subnet group to return details for.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter isn't currently supported.
        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 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 DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    DBSubnetGroupMessage:
      type: object
      properties:
        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.
        DBSubnetGroups:
          type: array
          items:
            $ref: '#/components/schemas/DBSubnetGroup'
          description: A list of DBSubnetGroup instances.
    ModifyDBSubnetGroupMessage:
      type: object
      properties:
        DBSubnetGroupName:
          type: string
          description: 'The name for the DB subnet group. This value is stored as a lowercase string. You can''t modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mydbsubnetgroup'
        DBSubnetGroupDescription:
          type: string
          description: The description for the DB subnet group.
        SubnetIds:
          type: array
          items:
            type: string
          description: The EC2 subnet IDs for the DB subnet group.
      required:
      - DBSubnetGroupName
      - SubnetIds
    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}_.:/=+\\-@]*)$").'
    AvailabilityZone:
      type: object
      properties:
        Name:
          type: string
          description: The name of the Availability Zone.
    InvalidDBSubnetGroupStateFault:
      type: object
      properties:
        message:
          type: string
    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
    DBSubnetGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    DBSubnetGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    ModifyDBSubnetGroupResult:
      type: object
      properties:
        DBSubnetGroup:
          $ref: '#/components/schemas/DBSubnetGroup'
    DeleteDBSubnetGroupMessage:
      type: object
      properties:
        DBSubnetGroupName:
          type: string
          description: 'The name of the database subnet group to delete. You can''t delete the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mydbsubnetgroup'
      required:
      - DBSubnetGroupName
    DBSubnetGroupDoesNotCoverEnoughAZs:
      type: object
      properties:
        message:
          type: string
    CreateDBSubnetGroupMessage:
      type: object
      properties:
        DBSubnetGroupName:
          type: string
          description: 'The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. First character must be a letter. Example: mydbsubnetgroup'
        DBSubnetGroupDescription:
          type: string
          description: The description for the DB subnet group.
        SubnetIds:
          type: array
          items:
            type: string
          description: The EC2 Subnet IDs for the DB subnet group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to assign to the DB subnet group.
      required:
      - DBSubnetGroupName
      - DBSubnetGroupDescription
      - SubnetIds
    DBSubnetGroup:
      type: object
      properties:
        DBSubnetGroupName:
          type: string
          description: The name of the DB subnet group.
        DBSubnetGroupDescription:
          type: string
          description: Provides the description of the DB subnet group.
        VpcId:
          type: string
          description: Provides the VpcId of the DB subnet group.
        SubnetGroupStatus:
          type: string
          description: Provides the status of the DB subnet group.
        Subnets:
          type: array
          items:
            $ref: '#/components/schemas/Subnet'
          description: Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.
        DBSubnetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB subnet group.
        SupportedNetworkTypes:
          type: array
          items:
            type: string
          description: 'The network type of the DB subnet group. Valid values: IPV4 DUAL A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.'
  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)