Amazon RDS Rds Custom Db Engine Version API

openapi: 3.2.0
info:
  title: Amazon Relational Database Service Custom Db Engine Version…
  version: '2014-10-31'
  description: Generated from AWS's published Smithy model for Amazon Relational Database Service. 3 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: Custom Db Engine Version
paths:
  /?Action=CreateCustomDBEngineVersion:
    post:
      operationId: CreateCustomDBEngineVersion
      summary: Create Custom DBEngine Version
      description: Creates a custom DB engine version (CEV).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBEngineVersion'
        '400':
          description: CreateCustomDBEngineVersionFault; CustomDBEngineVersionAlreadyExistsFault; CustomDBEngineVersionQuotaExceededFault; Ec2ImagePropertiesNotSupportedFault; InvalidCustomDBEngineVersionStateFault; KMSKeyNotAccessibleFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateCustomDBEngineVersionFault'
        '404':
          description: CustomDBEngineVersionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomDBEngineVersionNotFoundFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateCustomDBEngineVersion
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/CreateCustomDBEngineVersionMessage'
      tags:
      - Custom Db Engine Version
  /?Action=DeleteCustomDBEngineVersion:
    post:
      operationId: DeleteCustomDBEngineVersion
      summary: Delete Custom DBEngine Version
      description: 'Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn''t integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren''t logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBEngineVersion'
        '404':
          description: CustomDBEngineVersionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomDBEngineVersionNotFoundFault'
        '400':
          description: InvalidCustomDBEngineVersionStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidCustomDBEngineVersionStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteCustomDBEngineVersion
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/DeleteCustomDBEngineVersionMessage'
      tags:
      - Custom Db Engine Version
  /?Action=ModifyCustomDBEngineVersion:
    post:
      operationId: ModifyCustomDBEngineVersion
      summary: Modify Custom DBEngine Version
      description: Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DBEngineVersion'
        '404':
          description: CustomDBEngineVersionNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CustomDBEngineVersionNotFoundFault'
        '400':
          description: InvalidCustomDBEngineVersionStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidCustomDBEngineVersionStateFault'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyCustomDBEngineVersion
                  Version:
                    type: string
                    const: '2014-10-31'
              - $ref: '#/components/schemas/ModifyCustomDBEngineVersionMessage'
      tags:
      - Custom Db Engine Version
components:
  schemas:
    DeleteCustomDBEngineVersionMessage:
      type: object
      properties:
        Engine:
          type: string
          description: 'The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee'
        EngineVersion:
          type: string
          description: The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
      required:
      - Engine
      - EngineVersion
    CustomDBEngineVersionNotFoundFault:
      type: object
      properties:
        message:
          type: string
    CharacterSet:
      type: object
      properties:
        CharacterSetName:
          type: string
          description: The name of the character set.
        CharacterSetDescription:
          type: string
          description: The description of the character set.
    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}_.:/=+\\-@]*)$").'
    CustomDBEngineVersionAMI:
      type: object
      properties:
        ImageId:
          type: string
          description: A value that indicates the ID of the AMI.
        Status:
          type: string
          description: A value that indicates the status of a custom engine version (CEV).
    ModifyCustomDBEngineVersionMessage:
      type: object
      properties:
        Engine:
          type: string
          description: 'The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee'
        EngineVersion:
          type: string
          description: The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
        Description:
          type: string
          description: An optional description of your CEV.
        Status:
          type: string
          enum:
          - available
          - inactive
          - inactive-except-restore
          description: 'The availability status to be assigned to the CEV. Valid values are as follows: available You can use this CEV to create a new RDS Custom DB instance. inactive You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can''t patch or create new instances with this CEV. You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the '
      required:
      - Engine
      - EngineVersion
    DBEngineVersion:
      type: object
      properties:
        Engine:
          type: string
          description: The name of the database engine.
        MajorEngineVersion:
          type: string
          description: The major engine version of the CEV.
        EngineVersion:
          type: string
          description: The version number of the database engine.
        DatabaseInstallationFilesS3BucketName:
          type: string
          description: The name of the Amazon S3 bucket that contains your database installation files.
        DatabaseInstallationFilesS3Prefix:
          type: string
          description: The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
        DatabaseInstallationFiles:
          type: array
          items:
            type: string
          description: The database installation files (ISO and EXE) that were uploaded to Amazon S3 and used to import the database engine version to Amazon RDS. Returned for RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee) created from customer-supplied installation media.
        CustomDBEngineVersionManifest:
          type: string
          description: JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
        DBParameterGroupFamily:
          type: string
          description: The name of the DB parameter group family for the database engine.
        DBEngineDescription:
          type: string
          description: The description of the database engine.
        DBEngineVersionArn:
          type: string
          description: The ARN of the custom engine version.
        DBEngineVersionDescription:
          type: string
          description: The description of the database engine version.
        DefaultCharacterSet:
          $ref: '#/components/schemas/CharacterSet'
        FailureReason:
          type: string
          description: The reason that the custom engine version creation failed with an incompatible-installation-media status. Applicable to RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee).
        Image:
          $ref: '#/components/schemas/CustomDBEngineVersionAMI'
        DBEngineMediaType:
          type: string
          description: The source of the installation media for this engine version. A value of Customer Provided indicates that the engine version was created from customer-supplied installation media using CreateCustomDBEngineVersion. Applicable to RDS Custom for SQL Server and to RDS for SQL Server engine versions (sqlserver-ee and sqlserver-se with the bring-your-own-media license model, and sqlserver-dev-ee).
        KMSKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
        CreateTime:
          type: string
          format: date-time
          description: The creation time of the DB engine version.
        SupportedCharacterSets:
          type: array
          items:
            $ref: '#/components/schemas/CharacterSet'
          description: A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
        SupportedNcharCharacterSets:
          type: array
          items:
            $ref: '#/components/schemas/CharacterSet'
          description: A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
        ValidUpgradeTarget:
          type: array
          items:
            $ref: '#/components/schemas/UpgradeTarget'
          description: A list of engine versions that this database engine version can be upgraded to.
        SupportedTimezones:
          type: array
          items:
            $ref: '#/components/schemas/Timezone'
          description: A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
        ExportableLogTypes:
          type: array
          items:
            type: string
          description: The types of logs that the database engine has available for export to CloudWatch Logs.
        SupportsLogExportsToCloudwatchLogs:
          type: boolean
          description: Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
        SupportsReadReplica:
          type: boolean
          description: Indicates whether the database engine version supports read replicas.
        SupportedEngineModes:
          type: array
          items:
            type: string
          description: A list of the supported DB engine modes.
        SupportedFeatureNames:
          type: array
          items:
            type: string
          description: 'A list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command: aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version> For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: aws rds describe-db-engine-versions --engine postgres --engine-version 13.3 The supported features are listed under SupportedFeature'
        Status:
          type: string
          description: The status of the DB engine version, either available or deprecated.
        SupportsParallelQuery:
          type: boolean
          description: Indicates whether you can use Aurora parallel query with a specific DB engine version.
        SupportsGlobalDatabases:
          type: boolean
          description: Indicates whether you can use Aurora global databases with a specific DB engine version.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        SupportsBabelfish:
          type: boolean
          description: Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
        SupportsLimitlessDatabase:
          type: boolean
          description: Indicates whether the DB engine version supports Aurora Limitless Database.
        SupportsCertificateRotationWithoutRestart:
          type: boolean
          description: Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
        SupportedCACertificateIdentifiers:
          type: array
          items:
            type: string
          description: A list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
        SupportsLocalWriteForwarding:
          type: boolean
          description: 'Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren''t allowed on reader DB instances. Valid for: Aurora DB clusters only'
        SupportsIntegrations:
          type: boolean
          description: Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
        ServerlessV2FeaturesSupport:
          $ref: '#/components/schemas/ServerlessV2FeaturesSupport'
    InvalidCustomDBEngineVersionStateFault:
      type: object
      properties:
        message:
          type: string
    Timezone:
      type: object
      properties:
        TimezoneName:
          type: string
          description: The name of the time zone.
    UpgradeTarget:
      type: object
      properties:
        Engine:
          type: string
          description: The name of the upgrade target database engine.
        EngineVersion:
          type: string
          description: The version number of the upgrade target database engine.
        Description:
          type: string
          description: The version of the database engine that a DB instance can be upgraded to.
        AutoUpgrade:
          type: boolean
          description: Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true. This parameter is dynamic, and is set by RDS.
        IsMajorVersionUpgrade:
          type: boolean
          description: Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
        SupportedEngineModes:
          type: array
          items:
            type: string
          description: A list of the supported DB engine modes for the target engine version.
        SupportsParallelQuery:
          type: boolean
          description: Indicates whether you can use Aurora parallel query with the target engine version.
        SupportsGlobalDatabases:
          type: boolean
          description: Indicates whether you can use Aurora global databases with the target engine version.
        SupportsBabelfish:
          type: boolean
          description: Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
        SupportsLimitlessDatabase:
          type: boolean
          description: Indicates whether the DB engine version supports Aurora Limitless Database.
        SupportsLocalWriteForwarding:
          type: boolean
          description: 'Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren''t allowed on reader DB instances. Valid for: Aurora DB clusters only'
        SupportsIntegrations:
          type: boolean
          description: Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
    CreateCustomDBEngineVersionMessage:
      type: object
      properties:
        Engine:
          type: string
          description: 'The database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee'
        EngineVersion:
          type: string
          description: The name of your custom engine version (CEV). For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1. For RDS Custom for SQL Server and RDS for SQL Server sqlserver-dev-ee, the name format is *major_engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), specify the RDS engine version that you want to use. For example, 16.00.4175.1.v1. The CEV name is unique per customer per Amazon Web Services Regions.
        DatabaseInstallationFilesS3BucketName:
          type: string
          description: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
        DatabaseInstallationFilesS3Prefix:
          type: string
          description: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
        DatabaseInstallationFiles:
          type: array
          items:
            type: string
          description: The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), provide the SQL Server RTM ISO file once per major version and edition combination. Minor versions reuse the same file.
        ImageId:
          type: string
          description: The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
        KMSKeyId:
          type: string
          description: The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide. You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose diffe
        SourceCustomDbEngineVersionIdentifier:
          type: string
          description: The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
        UseAwsProvidedLatestImage:
          type: boolean
          description: Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.
        Description:
          type: string
          description: An optional description of your CEV.
        Manifest:
          type: string
          description: 'The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. The following JSON fields are valid: MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. databaseInstallationFileNames Ordered list of installation files for the CEV. opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNam'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - Engine
      - EngineVersion
    ServerlessV2FeaturesSupport:
      type: object
      properties:
        MinCapacity:
          type: number
          description: If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2.
        MaxCapacity:
          type: number
          description: Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be 256 or 128.
    CreateCustomDBEngineVersionFault:
      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)