Class CfnCustomDBEngineVersion
Creates a custom DB engine version (CEV).
Inherited Members
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
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCustomDBEngineVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCustomDBEngineVersion(Construct, String, ICfnCustomDBEngineVersionProps) |
Properties
AttrDbEngineVersionArn | The ARN of the custom engine version. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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>) |
Constructors
CfnCustomDBEngineVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCustomDBEngineVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCustomDBEngineVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCustomDBEngineVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCustomDBEngineVersion(Construct, String, ICfnCustomDBEngineVersionProps)
public CfnCustomDBEngineVersion(Construct scope, string id, ICfnCustomDBEngineVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnCustomDBEngineVersionProps
Resource properties.
Properties
AttrDbEngineVersionArn
The ARN of the custom engine version.
public virtual string AttrDbEngineVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DBEngineVersionArn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DatabaseInstallationFilesS3BucketName
The name of an Amazon S3 bucket that contains database installation files for your CEV.
public virtual string DatabaseInstallationFilesS3BucketName { get; set; }
Property Value
System.String
DatabaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files for your CEV.
public virtual string DatabaseInstallationFilesS3Prefix { get; set; }
Property Value
System.String
Description
An optional description of your CEV.
public virtual string Description { get; set; }
Property Value
System.String
Engine
The database engine to use for your custom engine version (CEV).
public virtual string Engine { get; set; }
Property Value
System.String
EngineVersion
The name of your CEV.
public virtual string EngineVersion { get; set; }
Property Value
System.String
ImageId
A value that indicates the ID of the AMI.
public virtual string ImageId { get; set; }
Property Value
System.String
KmsKeyId
The AWS KMS key identifier for an encrypted CEV.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
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
System.String
SourceCustomDbEngineVersionIdentifier
The ARN of a CEV to use as a source for creating a new CEV.
public virtual string SourceCustomDbEngineVersionIdentifier { get; set; }
Property Value
System.String
Status
A value that indicates the status of a custom engine version (CEV).
public virtual string Status { get; set; }
Property Value
System.String
Tags
UseAwsProvidedLatestImage
Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
public virtual object UseAwsProvidedLatestImage { get; set; }
Property Value
System.Object
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>