Interface ICfnCustomDBEngineVersionProps

Properties for defining a CfnCustomDBEngineVersion.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnCustomDBEngineVersionProps

Syntax (vb)

Public Interface ICfnCustomDBEngineVersionProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;

var cfnCustomDBEngineVersionProps = new CfnCustomDBEngineVersionProps {
    Engine = "engine",
    EngineVersion = "engineVersion",

    // the properties below are optional
    DatabaseInstallationFilesS3BucketName = "databaseInstallationFilesS3BucketName",
    DatabaseInstallationFilesS3Prefix = "databaseInstallationFilesS3Prefix",
    Description = "description",
    ImageId = "imageId",
    KmsKeyId = "kmsKeyId",
    Manifest = "manifest",
    SourceCustomDbEngineVersionIdentifier = "sourceCustomDbEngineVersionIdentifier",
    Status = "status",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UseAwsProvidedLatestImage = false
};

Synopsis

Properties

DatabaseInstallationFilesS3BucketName	The name of an Amazon S3 bucket that contains database installation files for your CEV.
DatabaseInstallationFilesS3Prefix	The Amazon S3 directory that contains the database installation files for your CEV.
Description	An optional description of your CEV.
Engine	The database engine to use for your custom engine version (CEV).
EngineVersion	The name of your CEV.
ImageId	A value that indicates the ID of the AMI.
KmsKeyId	The AWS KMS key identifier for an encrypted CEV.
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.
SourceCustomDbEngineVersionIdentifier	The ARN of a CEV to use as a source for creating a new CEV.
Status	A value that indicates the status of a custom engine version (CEV).
Tags	A list of tags.
UseAwsProvidedLatestImage	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

Properties

DatabaseInstallationFilesS3BucketName

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

virtual string DatabaseInstallationFilesS3BucketName { get; }

Property Value

System.String

Remarks

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

DatabaseInstallationFilesS3Prefix

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

virtual string DatabaseInstallationFilesS3Prefix { get; }

Property Value

System.String

Remarks

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.

virtual string Description { get; }

Property Value

System.String

Remarks

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

string Engine { get; }

Property Value

System.String

Remarks

Valid values:

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

EngineVersion

The name of your CEV.

string EngineVersion { get; }

Property Value

System.String

Remarks

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

ImageId

A value that indicates the ID of the AMI.

virtual string ImageId { get; }

Property Value

System.String

Remarks

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

KmsKeyId

The AWS KMS key identifier for an encrypted CEV.

virtual string KmsKeyId { get; }

Property Value

System.String

Remarks

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.

virtual string Manifest { get; }

Property Value

System.String

Remarks

The following JSON fields are valid:

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

SourceCustomDbEngineVersionIdentifier

The ARN of a CEV to use as a source for creating a new CEV.

virtual string SourceCustomDbEngineVersionIdentifier { get; }

Property Value

System.String

Remarks

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 .

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

Status

A value that indicates the status of a custom engine version (CEV).

virtual string Status { get; }

Property Value

System.String

Remarks

Default: - "available"

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

UseAwsProvidedLatestImage

Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

virtual object UseAwsProvidedLatestImage { get; }

Property Value

System.Object

Remarks

If you specify UseAwsProvidedLatestImage , you can't also specify ImageId .

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