Class: Aws::RDS::Types::ModifyCustomDBEngineVersionMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass ModifyCustomDBEngineVersionMessage data as a hash:

{
  engine: "CustomEngineName", # required
  engine_version: "CustomEngineVersion", # required
  description: "Description",
  status: "available", # accepts available, inactive, inactive-except-restore
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

An optional description of your CEV.

Returns:

  • (String)


14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14468

class ModifyCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :description,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

The DB engine. The only supported value is custom-oracle-ee.

Returns:

  • (String)


14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14468

class ModifyCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :description,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

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.

Returns:

  • (String)


14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14468

class ModifyCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :description,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14468

class ModifyCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :description,
  :status)
  SENSITIVE = []
  include Aws::Structure
end