RDS / Client / create_custom_db_engine_version

create_custom_db_engine_version

RDS.Client.create_custom_db_engine_version(**kwargs)

Creates a custom DB engine version (CEV).

See also: AWS API Documentation

Request Syntax

response = client.create_custom_db_engine_version(
    Engine='string',
    EngineVersion='string',
    DatabaseInstallationFilesS3BucketName='string',
    DatabaseInstallationFilesS3Prefix='string',
    ImageId='string',
    KMSKeyId='string',
    Description='string',
    Manifest='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SourceCustomDbEngineVersionIdentifier='string',
    UseAwsProvidedLatestImage=True|False
)

Parameters:

• Engine (string) –

  [REQUIRED]

  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

• EngineVersion (string) –

  [REQUIRED]

  The name of your CEV. The name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

• DatabaseInstallationFilesS3BucketName (string) – 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 (string) – 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.

• ImageId (string) – 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 (string) –

  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 different keys.

• Description (string) – An optional description of your CEV.

• Manifest (string) –

  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.

  OtherPatchFileNames

  The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

  For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

• Tags (list) –

  A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

  • (dict) –

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    • Key (string) –

      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 (string) –

      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}_.:/=+\-@]*)$”).

• SourceCustomDbEngineVersionIdentifier (string) – 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 (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Engine': 'string',
    'EngineVersion': 'string',
    'DBParameterGroupFamily': 'string',
    'DBEngineDescription': 'string',
    'DBEngineVersionDescription': 'string',
    'DefaultCharacterSet': {
        'CharacterSetName': 'string',
        'CharacterSetDescription': 'string'
    },
    'Image': {
        'ImageId': 'string',
        'Status': 'string'
    },
    'DBEngineMediaType': 'string',
    'SupportedCharacterSets': [
        {
            'CharacterSetName': 'string',
            'CharacterSetDescription': 'string'
        },
    ],
    'SupportedNcharCharacterSets': [
        {
            'CharacterSetName': 'string',
            'CharacterSetDescription': 'string'
        },
    ],
    'ValidUpgradeTarget': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'Description': 'string',
            'AutoUpgrade': True|False,
            'IsMajorVersionUpgrade': True|False,
            'SupportedEngineModes': [
                'string',
            ],
            'SupportsParallelQuery': True|False,
            'SupportsGlobalDatabases': True|False,
            'SupportsBabelfish': True|False,
            'SupportsLocalWriteForwarding': True|False,
            'SupportsIntegrations': True|False
        },
    ],
    'SupportedTimezones': [
        {
            'TimezoneName': 'string'
        },
    ],
    'ExportableLogTypes': [
        'string',
    ],
    'SupportsLogExportsToCloudwatchLogs': True|False,
    'SupportsReadReplica': True|False,
    'SupportedEngineModes': [
        'string',
    ],
    'SupportedFeatureNames': [
        'string',
    ],
    'Status': 'string',
    'SupportsParallelQuery': True|False,
    'SupportsGlobalDatabases': True|False,
    'MajorEngineVersion': 'string',
    'DatabaseInstallationFilesS3BucketName': 'string',
    'DatabaseInstallationFilesS3Prefix': 'string',
    'DBEngineVersionArn': 'string',
    'KMSKeyId': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'SupportsBabelfish': True|False,
    'CustomDBEngineVersionManifest': 'string',
    'SupportsCertificateRotationWithoutRestart': True|False,
    'SupportedCACertificateIdentifiers': [
        'string',
    ],
    'SupportsLocalWriteForwarding': True|False,
    'SupportsIntegrations': True|False
}

Response Structure

• (dict) –

  This data type is used as a response element in the action DescribeDBEngineVersions.

  • Engine (string) –

    The name of the database engine.

  • EngineVersion (string) –

    The version number of the database engine.

  • DBParameterGroupFamily (string) –

    The name of the DB parameter group family for the database engine.

  • DBEngineDescription (string) –

    The description of the database engine.

  • DBEngineVersionDescription (string) –

    The description of the database engine version.

  • DefaultCharacterSet (dict) –

    The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn’t specified.

    • CharacterSetName (string) –

      The name of the character set.

    • CharacterSetDescription (string) –

      The description of the character set.

  • Image (dict) –

    The EC2 image

    • ImageId (string) –

      A value that indicates the ID of the AMI.

    • Status (string) –

      A value that indicates the status of a custom engine version (CEV).

  • DBEngineMediaType (string) –

    A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

  • SupportedCharacterSets (list) –

    A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

    • (dict) –

      This data type is used as a response element in the action DescribeDBEngineVersions.

      • CharacterSetName (string) –

        The name of the character set.

      • CharacterSetDescription (string) –

        The description of the character set.

  • SupportedNcharCharacterSets (list) –

    A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

    • (dict) –

      This data type is used as a response element in the action DescribeDBEngineVersions.

      • CharacterSetName (string) –

        The name of the character set.

      • CharacterSetDescription (string) –

        The description of the character set.

  • ValidUpgradeTarget (list) –

    A list of engine versions that this database engine version can be upgraded to.

    • (dict) –

      The version of the database engine that a DB instance can be upgraded to.

      • Engine (string) –

        The name of the upgrade target database engine.

      • EngineVersion (string) –

        The version number of the upgrade target database engine.

      • Description (string) –

        The version of the database engine that a DB instance can be upgraded to.

      • AutoUpgrade (boolean) –

        Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

      • IsMajorVersionUpgrade (boolean) –

        Indicates whether upgrading to the target version requires upgrading the major version of the database engine.

      • SupportedEngineModes (list) –

        A list of the supported DB engine modes for the target engine version.

        • (string) –

      • SupportsParallelQuery (boolean) –

        Indicates whether you can use Aurora parallel query with the target engine version.

      • SupportsGlobalDatabases (boolean) –

        Indicates whether you can use Aurora global databases with the target engine version.

      • SupportsBabelfish (boolean) –

        Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

      • SupportsLocalWriteForwarding (boolean) –

        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 (boolean) –

        Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

  • SupportedTimezones (list) –

    A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

    • (dict) –

      A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

      • TimezoneName (string) –

        The name of the time zone.

  • ExportableLogTypes (list) –

    The types of logs that the database engine has available for export to CloudWatch Logs.

    • (string) –

  • SupportsLogExportsToCloudwatchLogs (boolean) –

    Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

  • SupportsReadReplica (boolean) –

    Indicates whether the database engine version supports read replicas.

  • SupportedEngineModes (list) –

    A list of the supported DB engine modes.

    • (string) –

  • SupportedFeatureNames (list) –

    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 SupportedFeatureNames in the output.

    • (string) –

  • Status (string) –

    The status of the DB engine version, either available or deprecated.

  • SupportsParallelQuery (boolean) –

    Indicates whether you can use Aurora parallel query with a specific DB engine version.

  • SupportsGlobalDatabases (boolean) –

    Indicates whether you can use Aurora global databases with a specific DB engine version.

  • MajorEngineVersion (string) –

    The major engine version of the CEV.

  • DatabaseInstallationFilesS3BucketName (string) –

    The name of the Amazon S3 bucket that contains your database installation files.

  • DatabaseInstallationFilesS3Prefix (string) –

    The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

  • DBEngineVersionArn (string) –

    The ARN of the custom engine version.

  • KMSKeyId (string) –

    The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

  • CreateTime (datetime) –

    The creation time of the DB engine version.

  • TagList (list) –

    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    • (dict) –

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • Key (string) –

        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 (string) –

        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}_.:/=+\-@]*)$”).

  • SupportsBabelfish (boolean) –

    Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

  • CustomDBEngineVersionManifest (string) –

    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.

  • SupportsCertificateRotationWithoutRestart (boolean) –

    Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

  • SupportedCACertificateIdentifiers (list) –

    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.

    • (string) –

  • SupportsLocalWriteForwarding (boolean) –

    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 (boolean) –

    Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

Exceptions

• RDS.Client.exceptions.CustomDBEngineVersionAlreadyExistsFault

• RDS.Client.exceptions.CustomDBEngineVersionQuotaExceededFault

• RDS.Client.exceptions.Ec2ImagePropertiesNotSupportedFault

• RDS.Client.exceptions.KMSKeyNotAccessibleFault

• RDS.Client.exceptions.CreateCustomDBEngineVersionFault