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

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

Overview

Note:

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

{
  engine: "CustomEngineName", # required
  engine_version: "CustomEngineVersion", # required
  database_installation_files_s3_bucket_name: "BucketName", # required
  database_installation_files_s3_prefix: "String255",
  kms_key_id: "KmsKeyIdOrArn", # required
  description: "Description",
  manifest: "CustomDBEngineVersionManifest", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_installation_files_s3_bucket_nameString

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)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#database_installation_files_s3_prefixString

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)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#descriptionString

An optional description of your CEV.

Returns:

  • (String)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#engineString

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

Returns:

  • (String)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#engine_versionString

The name of your CEV. The name format is `19.customized_string `. For example, a valid 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)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#kms_key_idString

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

If you have an existing symmetric 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 KMS key in your account, follow the instructions in [ Creating symmetric KMS keys] in the *Amazon Web Services Key Management Service Developer Guide*.

You can choose the same symmetric 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)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#manifestString

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)

1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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

#tagsArray<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:


1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/aws-sdk-rds/types.rb', line 1796

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