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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_installation_files ⇒ Array<String>

The database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS.

Returns:

  • (Array<String>) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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

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


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :source_custom_db_engine_version_identifier,
  :use_aws_provided_latest_image,
  :description,
  :manifest,
  :tags,
  :database_installation_files)
  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) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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

#description ⇒ String

An optional description of your CEV.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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

#engine ⇒ String

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

  • ccustom-sqlserver-web

  • custom-sqlserver-dev

RDS for SQL Server supports only sqlserver-dev-ee.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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

#engine_version ⇒ String

The name of your custom engine version (CEV).

For RDS Custom for Oracle, the name format is 19.*customized_string*. For example, a valid CEV name is 19.my_cev1.

For RDS for SQL Server and RDS Custom for SQL Server, the name format is major engine_version*.*minor_engine_version*.*customized_string*. For example, a valid CEV name is 16.00.4215.2.my_cev1.

The CEV name is unique per customer per Amazon Web Services Regions.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :source_custom_db_engine_version_identifier,
  :use_aws_provided_latest_image,
  :description,
  :manifest,
  :tags,
  :database_installation_files)
  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.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :source_custom_db_engine_version_identifier,
  :use_aws_provided_latest_image,
  :description,
  :manifest,
  :tags,
  :database_installation_files)
  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.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :source_custom_db_engine_version_identifier,
  :use_aws_provided_latest_image,
  :description,
  :manifest,
  :tags,
  :database_installation_files)
  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.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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

#source_custom_db_engine_version_identifier ⇒ String

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.

Returns:

  • (String) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

class CreateCustomDBEngineVersionMessage < Struct.new(
  :engine,
  :engine_version,
  :database_installation_files_s3_bucket_name,
  :database_installation_files_s3_prefix,
  :image_id,
  :kms_key_id,
  :source_custom_db_engine_version_identifier,
  :use_aws_provided_latest_image,
  :description,
  :manifest,
  :tags,
  :database_installation_files)
  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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Returns:



2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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

#use_aws_provided_latest_image ⇒ Boolean

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.

Returns:

  • (Boolean) 


2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2354

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