Modifies the status of a custom engine version (CEV)¶

Description¶

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling describe_db_engine_versions.

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.

Usage¶

rds_modify_custom_db_engine_version(Engine, EngineVersion, Description,
  Status)

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
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

[required] 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

An optional description of your CEV.
Status

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 availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

Value¶

A list with the following syntax:

list(
  Engine = "string",
  MajorEngineVersion = "string",
  EngineVersion = "string",
  DatabaseInstallationFilesS3BucketName = "string",
  DatabaseInstallationFilesS3Prefix = "string",
  DatabaseInstallationFiles = list(
    "string"
  ),
  CustomDBEngineVersionManifest = "string",
  DBParameterGroupFamily = "string",
  DBEngineDescription = "string",
  DBEngineVersionArn = "string",
  DBEngineVersionDescription = "string",
  DefaultCharacterSet = list(
    CharacterSetName = "string",
    CharacterSetDescription = "string"
  ),
  FailureReason = "string",
  Image = list(
    ImageId = "string",
    Status = "string"
  ),
  DBEngineMediaType = "string",
  KMSKeyId = "string",
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  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,
  TagList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SupportsBabelfish = TRUE|FALSE,
  SupportsLimitlessDatabase = TRUE|FALSE,
  SupportsCertificateRotationWithoutRestart = TRUE|FALSE,
  SupportedCACertificateIdentifiers = list(
    "string"
  ),
  SupportsLocalWriteForwarding = TRUE|FALSE,
  SupportsIntegrations = TRUE|FALSE,
  ServerlessV2FeaturesSupport = list(
    MinCapacity = 123.0,
    MaxCapacity = 123.0
  )
)

Request syntax¶

svc$modify_custom_db_engine_version(
  Engine = "string",
  EngineVersion = "string",
  Description = "string",
  Status = "available"|"inactive"|"inactive-except-restore"
)