CfnCustomDBEngineVersionProps

class aws_cdk.aws_rds.CfnCustomDBEngineVersionProps(*, engine, engine_version, database_installation_files_s3_bucket_name=None, database_installation_files_s3_prefix=None, description=None, image_id=None, kms_key_id=None, manifest=None, source_custom_db_engine_version_identifier=None, status=None, tags=None, use_aws_provided_latest_image=None)

Bases: object

Properties for defining a CfnCustomDBEngineVersion.

Parameters:

engine (str) – The database engine to use for your custom engine version (CEV). Valid values: - custom-oracle-ee - custom-oracle-ee-cdb
engine_version (str) – The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$ }
database_installation_files_s3_bucket_name (Optional[str]) – 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 .
database_installation_files_s3_prefix (Optional[str]) – 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.
description (Optional[str]) – An optional description of your CEV.
image_id (Optional[str]) – A value that indicates the ID of the AMI.
kms_key_id (Optional[str]) – The AWS 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 AWS 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.
manifest (Optional[str]) – 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 .
source_custom_db_engine_version_identifier (Optional[str]) – 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 .
status (Optional[str]) – A value that indicates the status of a custom engine version (CEV). Default: - “available”
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
use_aws_provided_latest_image (Union[bool, IResolvable, None]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

cfn_custom_dBEngine_version_props = rds.CfnCustomDBEngineVersionProps(
    engine="engine",
    engine_version="engineVersion",

    # the properties below are optional
    database_installation_files_s3_bucket_name="databaseInstallationFilesS3BucketName",
    database_installation_files_s3_prefix="databaseInstallationFilesS3Prefix",
    description="description",
    image_id="imageId",
    kms_key_id="kmsKeyId",
    manifest="manifest",
    source_custom_db_engine_version_identifier="sourceCustomDbEngineVersionIdentifier",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_aws_provided_latest_image=False
)

Attributes

database_installation_files_s3_bucket_name

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3bucketname

database_installation_files_s3_prefix

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3prefix

description

An optional description of your CEV.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-description

engine

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

Valid values:

custom-oracle-ee
custom-oracle-ee-cdb

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engine

engine_version

The name of your CEV.

The name format is major version.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.

Constraints: Minimum length is 1. Maximum length is 60.

Pattern: ^[a-z0-9_.-]{1,60$ }

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engineversion

image_id

A value that indicates the ID of the AMI.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-imageid

kms_key_id

The AWS 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 AWS 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-kmskeyid

manifest

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-manifest

source_custom_db_engine_version_identifier

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 .