Class CfnDBInstance
The AWS::DocDB::DBInstance
Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance.
Inherited Members
Namespace: Amazon.CDK.AWS.DocDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBInstance : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDBInstance
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see DBInstance in the Amazon DocumentDB Developer Guide .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html
CloudformationResource: AWS::DocDB::DBInstance
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.DocDB;
var cfnDBInstance = new CfnDBInstance(this, "MyCfnDBInstance", new CfnDBInstanceProps {
DbClusterIdentifier = "dbClusterIdentifier",
DbInstanceClass = "dbInstanceClass",
// the properties below are optional
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
CaCertificateIdentifier = "caCertificateIdentifier",
CertificateRotationRestart = false,
DbInstanceIdentifier = "dbInstanceIdentifier",
EnablePerformanceInsights = false,
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDBInstance(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBInstance(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDBInstance(Construct, String, ICfnDBInstanceProps) |
Properties
AttrEndpoint | The connection endpoint for the instance. |
AttrId | |
AttrPort | The port number on which the database accepts connections, such as |
AutoMinorVersionUpgrade | This parameter does not apply to Amazon DocumentDB. |
AvailabilityZone | The Amazon EC2 Availability Zone that the instance is created in. |
CaCertificateIdentifier | The CA certificate identifier to use for the DB instance's server certificate. |
CertificateRotationRestart | Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbClusterIdentifier | The identifier of the cluster that the instance will belong to. |
DbInstanceClass | The compute and memory capacity of the instance; |
DbInstanceIdentifier | The instance identifier. |
EnablePerformanceInsights | A value that indicates whether to enable Performance Insights for the DB Instance. |
PreferredMaintenanceWindow | The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to be assigned to the instance. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBInstance(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBInstance(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBInstance(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBInstance(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDBInstance(Construct, String, ICfnDBInstanceProps)
public CfnDBInstance(Construct scope, string id, ICfnDBInstanceProps 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 ICfnDBInstanceProps
Resource properties.
Properties
AttrEndpoint
The connection endpoint for the instance.
public virtual string AttrEndpoint { get; }
Property Value
System.String
Remarks
For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com
.
CloudformationAttribute: Endpoint
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrPort
The port number on which the database accepts connections, such as 27017
.
public virtual string AttrPort { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Port
AutoMinorVersionUpgrade
This parameter does not apply to Amazon DocumentDB.
public virtual object AutoMinorVersionUpgrade { get; set; }
Property Value
System.Object
AvailabilityZone
The Amazon EC2 Availability Zone that the instance is created in.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
CaCertificateIdentifier
The CA certificate identifier to use for the DB instance's server certificate.
public virtual string CaCertificateIdentifier { get; set; }
Property Value
System.String
CertificateRotationRestart
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
public virtual object CertificateRotationRestart { get; set; }
Property Value
System.Object
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
DbClusterIdentifier
The identifier of the cluster that the instance will belong to.
public virtual string DbClusterIdentifier { get; set; }
Property Value
System.String
DbInstanceClass
The compute and memory capacity of the instance;
public virtual string DbInstanceClass { get; set; }
Property Value
System.String
DbInstanceIdentifier
The instance identifier.
public virtual string DbInstanceIdentifier { get; set; }
Property Value
System.String
Remarks
This parameter is stored as a lowercase string.
EnablePerformanceInsights
A value that indicates whether to enable Performance Insights for the DB Instance.
public virtual object EnablePerformanceInsights { get; set; }
Property Value
System.Object
PreferredMaintenanceWindow
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to be assigned to the instance.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>