Class CfnCustomDBEngineVersionProps
Properties for defining a CfnCustomDBEngineVersion.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCustomDBEngineVersionProps : Object, ICfnCustomDBEngineVersionPropsSyntax (vb)
Public Class CfnCustomDBEngineVersionProps
Inherits Object
Implements ICfnCustomDBEngineVersionPropsRemarks
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
Constructors
| Cfn |
Properties
| Database |
The name of an Amazon S3 bucket that contains database installation files for your CEV. |
| Database |
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). |
| Engine |
The name of your CEV. |
| Image |
A value that indicates the ID of the AMI. |
| Kms |
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. |
| Source |
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. |
| Use |
Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. |
Constructors
CfnCustomDBEngineVersionProps()
public CfnCustomDBEngineVersionProps()Properties
DatabaseInstallationFilesS3BucketName
The name of an Amazon S3 bucket that contains database installation files for your CEV.
public string DatabaseInstallationFilesS3BucketName { get; set; }Property Value
System.
Remarks
For example, a valid bucket name is my-custom-installation-files .
DatabaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files for your CEV.
public string DatabaseInstallationFilesS3Prefix { get; set; }Property Value
System.
Remarks
For example, a valid bucket name is 123456789012/cev1 . If this setting isn't specified, no prefix is assumed.
Description
An optional description of your CEV.
public string Description { get; set; }Property Value
System.
Remarks
Engine
The database engine to use for your custom engine version (CEV).
public string Engine { get; set; }Property Value
System.
Remarks
EngineVersion
The name of your CEV.
public string EngineVersion { get; set; }Property Value
System.
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$ }
ImageId
A value that indicates the ID of the AMI.
public string ImageId { get; set; }Property Value
System.
Remarks
KmsKeyId
The AWS KMS key identifier for an encrypted CEV.
public string KmsKeyId { get; set; }Property Value
System.
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.
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.
public string Manifest { get; set; }Property Value
System.
Remarks
The following JSON fields are valid:
For more information, see Creating the CEV manifest in the Amazon RDS User Guide .
SourceCustomDbEngineVersionIdentifier
The ARN of a CEV to use as a source for creating a new CEV.
public string SourceCustomDbEngineVersionIdentifier { get; set; }Property Value
System.
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 .
Status
A value that indicates the status of a custom engine version (CEV).
public string Status { get; set; }Property Value
System.
Remarks
Tags
A list of tags.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
Remarks
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
UseAwsProvidedLatestImage
Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
public object UseAwsProvidedLatestImage { get; set; }Property Value
System.
Remarks
If you specify UseAwsProvidedLatestImage , you can't also specify ImageId .