Amazon RDS Rds Db Cluster Parameter Group API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Db Cluster Parameter…
  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 Cluster Parameter Group
paths:
  /?Action=CreateDBClusterParameterGroup:
    post:
      operationId: CreateDBClusterParameterGroup
      summary: Create DBCluster Parameter Group
      description: Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create a
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBClusterParameterGroupResult'
              example:
                DBClusterParameterGroup:
                  DBClusterParameterGroupName: mydbclusterparametergroup
                  DBParameterGroupFamily: aurora5.6
                  Description: My new cluster parameter group
                  DBClusterParameterGroupArn: arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup
        '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: CreateDBClusterParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateDBClusterParameterGroupMessage'
            example:
              DBClusterParameterGroupName: mydbclusterparametergroup
              DBParameterGroupFamily: aurora5.6
              Description: My new cluster parameter group
      tags:
      - Db Cluster Parameter Group
  /?Action=DeleteDBClusterParameterGroup:
    post:
      operationId: DeleteDBClusterParameterGroup
      summary: Delete DBCluster Parameter Group
      description: Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
      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: DeleteDBClusterParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteDBClusterParameterGroupMessage'
            example:
              DBClusterParameterGroupName: mydbclusterparametergroup
      tags:
      - Db Cluster Parameter Group
  /?Action=DescribeDBClusterParameterGroups:
    post:
      operationId: DescribeDBClusterParameterGroups
      summary: Describe DBCluster Parameter Groups
      description: Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterParameterGroupsMessage'
              example:
                DBClusterParameterGroups:
                - DBClusterParameterGroupName: default.aurora-mysql5.7
                  DBParameterGroupFamily: aurora-mysql5.7
                  Description: Default cluster parameter group for aurora-mysql5.7
                  DBClusterParameterGroupArn: arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7
                - DBClusterParameterGroupName: default.aurora-postgresql9.6
                  DBParameterGroupFamily: aurora-postgresql9.6
                  Description: Default cluster parameter group for aurora-postgresql9.6
                  DBClusterParameterGroupArn: arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6
                - DBClusterParameterGroupName: default.aurora5.6
                  DBParameterGroupFamily: aurora5.6
                  Description: Default cluster parameter group for aurora5.6
                  DBClusterParameterGroupArn: arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6
                - DBClusterParameterGroupName: mydbclusterpg
                  DBParameterGroupFamily: aurora-mysql5.7
                  Description: My DB cluster parameter group
                  DBClusterParameterGroupArn: arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg
                - DBClusterParameterGroupName: mydbclusterpgcopy
                  DBParameterGroupFamily: aurora-mysql5.7
                  Description: Copy of mydbclusterpg parameter group
                  DBClusterParameterGroupArn: arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy
        '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: DescribeDBClusterParameterGroups
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeDBClusterParameterGroupsMessage'
      tags:
      - Db Cluster Parameter Group
  /?Action=ModifyDBClusterParameterGroup:
    post:
      operationId: ModifyDBClusterParameterGroup
      summary: Modify DBCluster Parameter Group
      description: 'Modifies the parameters of a DB cluster 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. There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot. Changes to static parameters are applied only after the DB cluster is rebooted, which can be done using RebootDBCluster operation. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterParameterGroupNameMessage'
              example:
                DBClusterParameterGroupName: mydbclusterpg
        '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: ModifyDBClusterParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyDBClusterParameterGroupMessage'
            example:
              DBClusterParameterGroupName: mydbclusterpg
              Parameters:
              - ParameterName: server_audit_logging
                ParameterValue: '1'
                ApplyMethod: immediate
              - ParameterName: server_audit_logs_upload
                ParameterValue: '1'
                ApplyMethod: immediate
      tags:
      - Db Cluster Parameter Group
  /?Action=ResetDBClusterParameterGroup:
    post:
      operationId: ResetDBClusterParameterGroup
      summary: Reset DBCluster Parameter Group
      description: 'Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName 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. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterParameterGroupNameMessage'
              example:
                DBClusterParameterGroupName: mydbclpg
        '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: ResetDBClusterParameterGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ResetDBClusterParameterGroupMessage'
            example:
              DBClusterParameterGroupName: mydbclpg
              ResetAllParameters: true
      tags:
      - Db Cluster Parameter Group
components:
  schemas:
    DBClusterParameterGroupNameMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: 'The name of the DB cluster parameter group. Constraints: Must be 1 to 255 letters or numbers. 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.'
    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.
    ResetDBClusterParameterGroupMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: The name of the DB cluster parameter group to reset.
        ResetAllParameters:
          type: boolean
          description: Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
          description: A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.
      required:
      - DBClusterParameterGroupName
    ModifyDBClusterParameterGroupMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: The name of the DB cluster parameter group to modify.
        Parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
          description: 'A list of parameters in the DB cluster parameter group to modify. 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 clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the pa'
      required:
      - DBClusterParameterGroupName
      - Parameters
    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}_.:/=+\\-@]*)$").'
    DBClusterParameterGroup:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: The name of the DB cluster parameter group.
        DBParameterGroupFamily:
          type: string
          description: The name of the DB parameter group family that this DB cluster parameter group is compatible with.
        Description:
          type: string
          description: Provides the customer-specified description for this DB cluster parameter group.
        DBClusterParameterGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) for the DB cluster parameter group.
    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
    DBParameterGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    DescribeDBClusterParameterGroupsMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: 'The name of a specific DB cluster 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 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 DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    CreateDBClusterParameterGroupMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: 'The name of the DB cluster parameter group. Constraints: Must not match the name of an existing DB cluster parameter group. This value is stored as a lowercase string.'
        DBParameterGroupFamily:
          type: string
          description: 'The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --qu'
        Description:
          type: string
          description: The description for the DB cluster parameter group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to assign to the DB cluster parameter group.
      required:
      - DBClusterParameterGroupName
      - DBParameterGroupFamily
      - Description
    CreateDBClusterParameterGroupResult:
      type: object
      properties:
        DBClusterParameterGroup:
          $ref: '#/components/schemas/DBClusterParameterGroup'
    DBClusterParameterGroupsMessage:
      type: object
      properties:
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        DBClusterParameterGroups:
          type: array
          items:
            $ref: '#/components/schemas/DBClusterParameterGroup'
          description: A list of DB cluster parameter groups.
    InvalidDBParameterGroupStateFault:
      type: object
      properties:
        message:
          type: string
    DeleteDBClusterParameterGroupMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: 'The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can''t delete a default DB cluster parameter group. Can''t be associated with any DB clusters.'
      required:
      - DBClusterParameterGroupName
  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)