Amazon RDS Rds Db Parameter Group API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Parameter Group API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 5 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 Parameter Group
paths:
  /?Action=CreateDBParameterGroup:
    post:
      operationId: CreateDBParameterGroup
      summary: Create DBParameter Group
      description: Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBParameterGroupResult'
              example:
                DBParameterGroup:
                  DBParameterGroupName: mydbparametergroup
                  DBParameterGroupFamily: mysql8.0
                  Description: My new parameter group
                  DBParameterGroupArn: arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup
        '400':
          description: DBParameterGroupAlreadyExistsFault; DBParameterGroupQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDBParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBParameterGroupMessage'
            example:
              DBParameterGroupName: mydbparametergroup
              DBParameterGroupFamily: MySQL8.0
              Description: My new parameter group
      tags:
      - Db Parameter Group
  /?Action=DeleteDBParameterGroup:
    post:
      operationId: DeleteDBParameterGroup
      summary: Delete DBParameter Group
      description: Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: DBParameterGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupNotFoundFault'
        '400':
          description: InvalidDBParameterGroupStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBParameterGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDBParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBParameterGroupMessage'
            example:
              DBParameterGroupName: mydbparametergroup
      tags:
      - Db Parameter Group
  /?Action=DescribeDBParameterGroups:
    post:
      operationId: DescribeDBParameterGroups
      summary: Describe DBParameter Groups
      description: Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupsMessage'
              example:
                DBParameterGroups:
                - DBParameterGroupName: default.aurora-mysql5.7
                  DBParameterGroupFamily: aurora-mysql5.7
                  Description: Default parameter group for aurora-mysql5.7
                  DBParameterGroupArn: arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7
                - DBParameterGroupName: default.aurora-postgresql9.6
                  DBParameterGroupFamily: aurora-postgresql9.6
                  Description: Default parameter group for aurora-postgresql9.6
                  DBParameterGroupArn: arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6
                - DBParameterGroupName: default.aurora5.6
                  DBParameterGroupFamily: aurora5.6
                  Description: Default parameter group for aurora5.6
                  DBParameterGroupArn: arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6
                - DBParameterGroupName: default.mariadb10.1
                  DBParameterGroupFamily: mariadb10.1
                  Description: Default parameter group for mariadb10.1
                  DBParameterGroupArn: arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1
        '404':
          description: DBParameterGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDBParameterGroups
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBParameterGroupsMessage'
      tags:
      - Db Parameter Group
  /?Action=ModifyDBParameterGroup:
    post:
      operationId: ModifyDBParameterGroup
      summary: Modify DBParameter Group
      description: 'Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupNameMessage'
              example:
                DBParameterGroupName: test-sqlserver-se-2017
        '404':
          description: DBParameterGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupNotFoundFault'
        '400':
          description: InvalidDBParameterGroupStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBParameterGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyDBParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBParameterGroupMessage'
            example:
              DBParameterGroupName: test-sqlserver-se-2017
              Parameters:
              - ParameterName: clr enabled
                ParameterValue: '1'
                ApplyMethod: immediate
      tags:
      - Db Parameter Group
  /?Action=ResetDBParameterGroup:
    post:
      operationId: ResetDBParameterGroup
      summary: Reset DBParameter Group
      description: 'Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupNameMessage'
              example:
                DBParameterGroupName: mypg
        '404':
          description: DBParameterGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBParameterGroupNotFoundFault'
        '400':
          description: InvalidDBParameterGroupStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidDBParameterGroupStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ResetDBParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ResetDBParameterGroupMessage'
            example:
              DBParameterGroupName: mypg
              ResetAllParameters: true
      tags:
      - Db Parameter Group
components:
  schemas:
    CreateDBParameterGroupMessage:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: 'The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can''t end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.'
        DBParameterGroupFamily:
          type: string
          description: 'The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: aws rds descr'
        Description:
          type: string
          description: The description for the DB parameter group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to assign to the DB parameter group.
      required:
      - DBParameterGroupName
      - DBParameterGroupFamily
      - Description
    ResetDBParameterGroupMessage:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: 'The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup.'
        ResetAllParameters:
          type: boolean
          description: Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
          description: 'To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request. MySQL Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. MariaDB Valid Values (for Apply method): immediate | pending-reboot You can us'
      required:
      - DBParameterGroupName
    DBParameterGroupNameMessage:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: The name of the DB parameter group.
    DBParameterGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    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}_.:/=+\\-@]*)$").'
    CreateDBParameterGroupResult:
      type: object
      properties:
        DBParameterGroup:
          $ref: '#/components/schemas/DBParameterGroup'
    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
    DeleteDBParameterGroupMessage:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: 'The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group You can''t delete a default DB parameter group Can''t be associated with any DB instances'
      required:
      - DBParameterGroupName
    DescribeDBParameterGroupsMessage:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: 'The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.'
        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 DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    ModifyDBParameterGroupMessage:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: 'The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup.'
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
          description: 'An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters. When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated wi'
      required:
      - DBParameterGroupName
      - Parameters
    DBParameterGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DBParameterGroup:
      type: object
      properties:
        DBParameterGroupName:
          type: string
          description: The name of the DB parameter group.
        DBParameterGroupFamily:
          type: string
          description: The name of the DB parameter group family that this DB parameter group is compatible with.
        Description:
          type: string
          description: Provides the customer-specified description for this DB parameter group.
        DBParameterGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB parameter group.
    DBParameterGroupsMessage:
      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.
        DBParameterGroups:
          type: array
          items:
            $ref: '#/components/schemas/DBParameterGroup'
          description: A list of DBParameterGroup instances.
    Parameter:
      type: object
      properties:
        ParameterName:
          type: string
          description: The name of the parameter.
        ParameterValue:
          type: string
          description: The value of the parameter.
        Description:
          type: string
          description: Provides a description of the parameter.
        Source:
          type: string
          description: The source of the parameter value.
        ApplyType:
          type: string
          description: Specifies the engine specific parameters type.
        DataType:
          type: string
          description: Specifies the valid data type for the parameter.
        AllowedValues:
          type: string
          description: Specifies the valid range of values for the parameter.
        IsModifiable:
          type: boolean
          description: Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
        MinimumEngineVersion:
          type: string
          description: The earliest engine version to which the parameter can apply.
        ApplyMethod:
          type: string
          enum:
          - immediate
          - pending-reboot
          description: Indicates when to apply parameter updates.
        SupportedEngineModes:
          type: array
          items:
            type: string
          description: The valid DB engine modes.
    InvalidDBParameterGroupStateFault:
      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)