Class: Aws::RDS::Types::CreateCustomDBEngineVersionMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::CreateCustomDBEngineVersionMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #database_installation_files_s3_bucket_name ⇒ String

  The name of an Amazon S3 bucket that contains database installation files for your CEV.

• #database_installation_files_s3_prefix ⇒ String

  The Amazon S3 directory that contains the database installation files for your CEV.

• #description ⇒ String

  An optional description of your CEV.

• #engine ⇒ String

  The database engine to use for your custom engine version (CEV).

• #engine_version ⇒ String

  The name of your CEV.

• #image_id ⇒ String

  The ID of the Amazon Machine Image (AMI).

• #kms_key_id ⇒ String

  The Amazon Web Services KMS key identifier for an encrypted CEV.

• #manifest ⇒ String

  The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3.

• #tags ⇒ Array<Types::Tag>

  A list of tags.

Instance Attribute Details

#database_installation_files_s3_bucket_name ⇒ 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`.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#database_installation_files_s3_prefix ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description of your CEV.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The database engine to use for your custom engine version (CEV). The only supported value is ‘custom-oracle-ee`.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ 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.

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ 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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-rds/types.rb', line 1893

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :description,
  :manifest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end