Skip to content

Create Custom Db Engine Version

rds_create_custom_db_engine_version R Documentation

Creates a custom DB engine version (CEV)

Description

Creates a custom DB engine version (CEV).

Usage

rds_create_custom_db_engine_version(Engine, EngineVersion,
  DatabaseInstallationFilesS3BucketName,
  DatabaseInstallationFilesS3Prefix, ImageId, KMSKeyId, Description,
  Manifest, Tags, SourceCustomDbEngineVersionIdentifier,
  UseAwsProvidedLatestImage)

Arguments

Engine

[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

[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

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

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

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 describe_db_engine_versions operation.

KMSKeyId

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

An optional description of your CEV.

Manifest

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
SourceCustomDbEngineVersionIdentifier

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

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.

Value

A list with the following syntax: 

list(
  Engine = "string",
  EngineVersion = "string",
  DBParameterGroupFamily = "string",
  DBEngineDescription = "string",
  DBEngineVersionDescription = "string",
  DefaultCharacterSet = list(
    CharacterSetName = "string",
    CharacterSetDescription = "string"
  ),
  Image = list(
    ImageId = "string",
    Status = "string"
  ),
  DBEngineMediaType = "string",
  SupportedCharacterSets = list(
    list(
      CharacterSetName = "string",
      CharacterSetDescription = "string"
    )
  ),
  SupportedNcharCharacterSets = list(
    list(
      CharacterSetName = "string",
      CharacterSetDescription = "string"
    )
  ),
  ValidUpgradeTarget = list(
    list(
      Engine = "string",
      EngineVersion = "string",
      Description = "string",
      AutoUpgrade = TRUE|FALSE,
      IsMajorVersionUpgrade = TRUE|FALSE,
      SupportedEngineModes = list(
        "string"
      ),
      SupportsParallelQuery = TRUE|FALSE,
      SupportsGlobalDatabases = TRUE|FALSE,
      SupportsBabelfish = TRUE|FALSE,
      SupportsLimitlessDatabase = TRUE|FALSE,
      SupportsLocalWriteForwarding = TRUE|FALSE,
      SupportsIntegrations = TRUE|FALSE
    )
  ),
  SupportedTimezones = list(
    list(
      TimezoneName = "string"
    )
  ),
  ExportableLogTypes = list(
    "string"
  ),
  SupportsLogExportsToCloudwatchLogs = TRUE|FALSE,
  SupportsReadReplica = TRUE|FALSE,
  SupportedEngineModes = list(
    "string"
  ),
  SupportedFeatureNames = list(
    "string"
  ),
  Status = "string",
  SupportsParallelQuery = TRUE|FALSE,
  SupportsGlobalDatabases = TRUE|FALSE,
  MajorEngineVersion = "string",
  DatabaseInstallationFilesS3BucketName = "string",
  DatabaseInstallationFilesS3Prefix = "string",
  DBEngineVersionArn = "string",
  KMSKeyId = "string",
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  TagList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SupportsBabelfish = TRUE|FALSE,
  CustomDBEngineVersionManifest = "string",
  SupportsLimitlessDatabase = TRUE|FALSE,
  SupportsCertificateRotationWithoutRestart = TRUE|FALSE,
  SupportedCACertificateIdentifiers = list(
    "string"
  ),
  SupportsLocalWriteForwarding = TRUE|FALSE,
  SupportsIntegrations = TRUE|FALSE
)

Request syntax

svc$create_custom_db_engine_version(
  Engine = "string",
  EngineVersion = "string",
  DatabaseInstallationFilesS3BucketName = "string",
  DatabaseInstallationFilesS3Prefix = "string",
  ImageId = "string",
  KMSKeyId = "string",
  Description = "string",
  Manifest = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SourceCustomDbEngineVersionIdentifier = "string",
  UseAwsProvidedLatestImage = TRUE|FALSE
)