Class CfnCustomDBEngineVersion

Creates a custom DB engine version (CEV).

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCustomDBEngineVersion

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCustomDBEngineVersion : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnCustomDBEngineVersion Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

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 cfnCustomDBEngineVersion = new CfnCustomDBEngineVersion(this, "MyCfnCustomDBEngineVersion", 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

CfnCustomDBEngineVersion(Construct, string, ICfnCustomDBEngineVersionProps)

Creates a custom DB engine version (CEV).

Properties

AttrDbEngineVersionArn	The ARN of the custom engine version.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a custom DB engine version (CEV).
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates a custom DB engine version (CEV).

Constructors

CfnCustomDBEngineVersion(Construct, string, ICfnCustomDBEngineVersionProps)

Creates a custom DB engine version (CEV).

public CfnCustomDBEngineVersion(Construct scope, string id, ICfnCustomDBEngineVersionProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnCustomDBEngineVersionProps

Resource properties.

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Properties

AttrDbEngineVersionArn

The ARN of the custom engine version.

public virtual string AttrDbEngineVersionArn { get; }

Property Value

string

Remarks

CloudformationAttribute: DBEngineVersionArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

CfnProperties

Creates a custom DB engine version (CEV).

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

DatabaseInstallationFilesS3BucketName

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

public virtual string? DatabaseInstallationFilesS3BucketName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

DatabaseInstallationFilesS3Prefix

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

public virtual string? DatabaseInstallationFilesS3Prefix { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Description

An optional description of your CEV.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Engine

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

public virtual string Engine { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

EngineVersion

The name of your CEV.

public virtual string EngineVersion { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

ImageId

A value that indicates the ID of the AMI.

public virtual string? ImageId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

KmsKeyId

The AWS KMS key identifier for an encrypted CEV.

public virtual string? KmsKeyId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

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 virtual string? Manifest { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

SourceCustomDbEngineVersionIdentifier

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

public virtual string? SourceCustomDbEngineVersionIdentifier { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Status

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

public virtual string? Status { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Tags

A list of tags.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

UseAwsProvidedLatestImage

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

public virtual object? UseAwsProvidedLatestImage { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a custom DB engine version (CEV).

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::RDS::CustomDBEngineVersion

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2