Amazon RDS Rds Option Group API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Option 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: Option Group
paths:
  /?Action=CreateOptionGroup:
    post:
      operationId: CreateOptionGroup
      summary: Create Option Group
      description: Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateOptionGroupResult'
              example:
                OptionGroup:
                  OptionGroupName: myoptiongroup
                  OptionGroupDescription: MySQL 8.0 option group
                  EngineName: mysql
                  MajorEngineVersion: '8.0'
                  Options: []
                  AllowsVpcAndNonVpcInstanceMemberships: true
                  OptionGroupArn: arn:aws:rds:us-east-1:123456789012:og:myoptiongroup
        '400':
          description: OptionGroupAlreadyExistsFault; OptionGroupQuotaExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OptionGroupAlreadyExistsFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateOptionGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateOptionGroupMessage'
            example:
              OptionGroupName: MyOptionGroup
              EngineName: mysql
              MajorEngineVersion: '8.0'
              OptionGroupDescription: MySQL 8.0 option group
      tags:
      - Option Group
  /?Action=DeleteOptionGroup:
    post:
      operationId: DeleteOptionGroup
      summary: Delete Option Group
      description: Deletes an existing option group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: InvalidOptionGroupStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidOptionGroupStateFault'
        '404':
          description: OptionGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OptionGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteOptionGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteOptionGroupMessage'
            example:
              OptionGroupName: myoptiongroup
      tags:
      - Option Group
  /?Action=DescribeOptionGroups:
    post:
      operationId: DescribeOptionGroups
      summary: Describe Option Groups
      description: Describes the available option groups.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OptionGroups'
              example:
                OptionGroupsList:
                - OptionGroupName: default:oracle-ee-19
                  OptionGroupDescription: Default option group for oracle-ee 19
                  EngineName: oracle-ee
                  MajorEngineVersion: '19'
                  Options: []
                  AllowsVpcAndNonVpcInstanceMemberships: true
                  OptionGroupArn: arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19
        '404':
          description: OptionGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OptionGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeOptionGroups
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DescribeOptionGroupsMessage'
            example:
              EngineName: oracle-ee
              MajorEngineVersion: '19'
      tags:
      - Option Group
  /?Action=ModifyOptionGroup:
    post:
      operationId: ModifyOptionGroup
      summary: Modify Option Group
      description: Modifies an existing option group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyOptionGroupResult'
              example:
                OptionGroup: {}
        '400':
          description: InvalidOptionGroupStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidOptionGroupStateFault'
        '404':
          description: OptionGroupNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/OptionGroupNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyOptionGroup
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyOptionGroupMessage'
            example:
              OptionGroupName: myawsuser-og02
              OptionsToInclude:
              - OptionName: MEMCACHED
                DBSecurityGroupMemberships:
                - default
              ApplyImmediately: true
      tags:
      - Option Group
components:
  schemas:
    OptionConfiguration:
      type: object
      properties:
        OptionName:
          type: string
          description: The configuration of options to include in a group.
        Port:
          type: integer
          description: The optional port for the option.
        OptionVersion:
          type: string
          description: The version for the option.
        DBSecurityGroupMemberships:
          type: array
          items:
            type: string
          description: A list of DB security groups used for this option.
        VpcSecurityGroupMemberships:
          type: array
          items:
            type: string
          description: A list of VPC security group names used for this option.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/OptionSetting'
          description: The option settings to include in an option group.
      required:
      - OptionName
    OptionGroups:
      type: object
      properties:
        OptionGroupsList:
          type: array
          items:
            $ref: '#/components/schemas/OptionGroup'
          description: List of option groups.
        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.
    DeleteOptionGroupMessage:
      type: object
      properties:
        OptionGroupName:
          type: string
          description: The name of the option group to be deleted. You can't delete default option groups.
      required:
      - OptionGroupName
    CreateOptionGroupResult:
      type: object
      properties:
        OptionGroup:
          $ref: '#/components/schemas/OptionGroup'
    OptionGroupNotFoundFault:
      type: object
      properties:
        message:
          type: string
    OptionGroupAlreadyExistsFault:
      type: object
      properties:
        message:
          type: string
    Option:
      type: object
      properties:
        OptionName:
          type: string
          description: The name of the option.
        OptionDescription:
          type: string
          description: The description of the option.
        Persistent:
          type: boolean
          description: Indicates whether this option is persistent.
        Permanent:
          type: boolean
          description: Indicates whether this option is permanent.
        Port:
          type: integer
          description: If required, the port configured for this option to use.
        OptionVersion:
          type: string
          description: The version of the option.
        OptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/OptionSetting'
          description: The option settings for this option.
        DBSecurityGroupMemberships:
          type: array
          items:
            $ref: '#/components/schemas/DBSecurityGroupMembership'
          description: If the option requires access to a port, then this DB security group allows access to the port.
        VpcSecurityGroupMemberships:
          type: array
          items:
            $ref: '#/components/schemas/VpcSecurityGroupMembership'
          description: If the option requires access to a port, then this VPC security group allows access to the port.
    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}_.:/=+\\-@]*)$").'
    OptionSetting:
      type: object
      properties:
        Name:
          type: string
          description: The name of the option that has settings that you can set.
        Value:
          type: string
          description: The current value of the option setting.
        DefaultValue:
          type: string
          description: The default value of the option setting.
        Description:
          type: string
          description: The description of the option setting.
        ApplyType:
          type: string
          description: The DB engine specific parameter type.
        DataType:
          type: string
          description: The data type of the option setting.
        AllowedValues:
          type: string
          description: The allowed values of the option setting.
        IsModifiable:
          type: boolean
          description: Indicates whether the option setting can be modified from the default.
        IsCollection:
          type: boolean
          description: Indicates whether the option setting is part of a collection.
    OptionGroup:
      type: object
      properties:
        OptionGroupName:
          type: string
          description: Specifies the name of the option group.
        OptionGroupDescription:
          type: string
          description: Provides a description of the option group.
        EngineName:
          type: string
          description: Indicates the name of the engine that this option group can be applied to.
        MajorEngineVersion:
          type: string
          description: Indicates the major engine version associated with this option group.
        Options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
          description: Indicates what options are available in the option group.
        AllowsVpcAndNonVpcInstanceMemberships:
          type: boolean
          description: Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
        VpcId:
          type: string
          description: If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
        OptionGroupArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) for the option group.
        SourceOptionGroup:
          type: string
          description: Specifies the name of the option group from which this option group is copied.
        SourceAccountId:
          type: string
          description: Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
        CopyTimestamp:
          type: string
          format: date-time
          description: Indicates when the option group was copied.
    ModifyOptionGroupMessage:
      type: object
      properties:
        OptionGroupName:
          type: string
          description: The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
        OptionsToInclude:
          type: array
          items:
            $ref: '#/components/schemas/OptionConfiguration'
          description: Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
        OptionsToRemove:
          type: array
          items:
            type: string
          description: Options in this list are removed from the option group.
        ApplyImmediately:
          type: boolean
          description: Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
      required:
      - OptionGroupName
    DescribeOptionGroupsMessage:
      type: object
      properties:
        OptionGroupName:
          type: string
          description: The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: This parameter isn't currently supported.
        Marker:
          type: string
          description: An optional pagination token provided by a previous DescribeOptionGroups 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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
        EngineName:
          type: string
          description: 'A filter to only include option groups associated with this database engine. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web'
        MajorEngineVersion:
          type: string
          description: Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
    VpcSecurityGroupMembership:
      type: object
      properties:
        VpcSecurityGroupId:
          type: string
          description: The name of the VPC security group.
        Status:
          type: string
          description: The membership status of the VPC security group. Currently, the only valid status is active.
    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
    CreateOptionGroupMessage:
      type: object
      properties:
        OptionGroupName:
          type: string
          description: 'Specifies the name of the option group to be created. 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 Example: myoptiongroup'
        EngineName:
          type: string
          description: 'The name of the engine to associate this option group with. Valid Values: db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web'
        MajorEngineVersion:
          type: string
          description: Specifies the major version of the engine that this option group should be associated with.
        OptionGroupDescription:
          type: string
          description: The description of the option group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to assign to the option group.
      required:
      - OptionGroupName
      - EngineName
      - MajorEngineVersion
      - OptionGroupDescription
    DBSecurityGroupMembership:
      type: object
      properties:
        DBSecurityGroupName:
          type: string
          description: The name of the DB security group.
        Status:
          type: string
          description: The status of the DB security group.
    InvalidOptionGroupStateFault:
      type: object
      properties:
        message:
          type: string
    ModifyOptionGroupResult:
      type: object
      properties:
        OptionGroup:
          $ref: '#/components/schemas/OptionGroup'
  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)