Amazon Neptune Neptune Db Cluster Parameter Group API

openapi: 3.1.0
info:
  title: Amazon Neptune Db Cluster Parameter Group API
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Neptune. 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: []
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 DB cluster, you need to reboot the DB instances in 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 Neptune to fully complete the create action before the DB cluster parameter group
        is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating
        the default database for a DB cl
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDBClusterParameterGroupResult'
        '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'
      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.
      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'
      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.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterParameterGroupsMessage'
        '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. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot
        without failover to the DB cluster associated with the parameter group before the change can 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 Neptune to fully complete
        the create action before the parameter group is used as the default for a new DB cluster. This is especially important
        for parameters that are critical when creating the default database for a DB cluster, 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has
        been created or modified.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterParameterGroupNameMessage'
        '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'
      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.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBClusterParameterGroupNameMessage'
        '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'
      tags:
      - Db Cluster Parameter Group
components:
  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
  schemas:
    CreateDBClusterParameterGroupMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: 'The name of the DB cluster parameter group. Constraints: Must match the name of an existing DBClusterParameterGroup.
            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.
        Description:
          type: string
          description: The description for the DB cluster parameter group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the new DB cluster parameter group.
      required:
      - DBClusterParameterGroupName
      - DBParameterGroupFamily
      - Description
    CreateDBClusterParameterGroupResult:
      type: object
      properties:
        DBClusterParameterGroup:
          $ref: '#/components/schemas/DBClusterParameterGroup'
    DBClusterParameterGroup:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: Provides the name of the DB cluster parameter group.
        DBParameterGroupFamily:
          type: string
          description: Provides 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.
    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 Cannot end with a hyphen or contain two consecutive hyphens This value is stored as
            a lowercase string.'
    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.
    DBParameterGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    DBParameterGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    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. Cannot be associated with any DB clusters.'
      required:
      - DBClusterParameterGroupName
    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 is not 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 the remaining results
            can be retrieved. 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.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: This parameter is not currently supported.
        Values:
          type: array
          items:
            type: string
          description: This parameter is not currently supported.
      required:
      - Name
      - Values
    InvalidDBParameterGroupStateFault:
      type: object
      properties:
        message:
          type: string
          description: A message describing the details of the problem.
    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.
      required:
      - DBClusterParameterGroupName
      - Parameters
    Parameter:
      type: object
      properties:
        ParameterName:
          type: string
          description: Specifies the name of the parameter.
        ParameterValue:
          type: string
          description: Specifies the value of the parameter.
        Description:
          type: string
          description: Provides a description of the parameter.
        Source:
          type: string
          description: Indicates 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.
    ResetDBClusterParameterGroupMessage:
      type: object
      properties:
        DBClusterParameterGroupName:
          type: string
          description: The name of the DB cluster parameter group to reset.
        ResetAllParameters:
          type: boolean
          description: A value that is set to true to reset all parameters in the DB cluster parameter group to their default
            values, and false otherwise. 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 set to true.
      required:
      - DBClusterParameterGroupName
    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 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 the set of Unicode letters, digits,
            white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/neptune/service/2014-10-31/neptune-2014-10-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)