Class CfnDBInstance

A CloudFormation AWS::DocDB::DBInstance.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnDBInstance
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.DocDB
Assembly: Amazon.CDK.AWS.DocDB.dll
Syntax (csharp)
public class CfnDBInstance : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBInstance
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

The AWS::DocDB::DBInstance Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance. For more information, see DBInstance in the Amazon DocumentDB Developer Guide .

CloudformationResource: AWS::DocDB::DBInstance

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.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.DocDB;

CfnDBInstance cfnDBInstance = new CfnDBInstance(this, "MyCfnDBInstance", new CfnDBInstanceProps {
    DbClusterIdentifier = "dbClusterIdentifier",
    DbInstanceClass = "dbInstanceClass",

    // the properties below are optional
    AutoMinorVersionUpgrade = false,
    AvailabilityZone = "availabilityZone",
    DbInstanceIdentifier = "dbInstanceIdentifier",
    EnablePerformanceInsights = false,
    PreferredMaintenanceWindow = "preferredMaintenanceWindow",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnDBInstance(Construct, String, ICfnDBInstanceProps)

Create a new AWS::DocDB::DBInstance.
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

Properties

AttrEndpoint

The connection endpoint for the instance.
AttrPort

The port number on which the database accepts connections, such as 27017 .
AutoMinorVersionUpgrade

This parameter does not apply to Amazon DocumentDB.
AvailabilityZone

The Amazon EC2 Availability Zone that the instance is created in.
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. This parameter is stored as a lowercase string.
EnablePerformanceInsights

AWS::DocDB::DBInstance.EnablePerformanceInsights.
PreferredMaintenanceWindow

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Tags

The tags to be assigned to the instance.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDBInstance(Construct, String, ICfnDBInstanceProps)

Create a new AWS::DocDB::DBInstance.

public CfnDBInstance(Construct scope, string id, ICfnDBInstanceProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnDBInstanceProps
  • resource properties.

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

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

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

Remarks

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade

AvailabilityZone

The Amazon EC2 Availability Zone that the instance is created in.

public virtual string AvailabilityZone { get; set; }
Property Value

System.String

Remarks

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

Example: us-east-1d

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone

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

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier

DbInstanceClass

The compute and memory capacity of the instance;

public virtual string DbInstanceClass { get; set; }
Property Value

System.String

Remarks

for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass

DbInstanceIdentifier

The instance identifier. This parameter is stored as a lowercase string.

public virtual string DbInstanceIdentifier { get; set; }
Property Value

System.String

Remarks

Constraints:

    Example: mydbinstance

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier

    EnablePerformanceInsights

    AWS::DocDB::DBInstance.EnablePerformanceInsights.

    public virtual object EnablePerformanceInsights { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-enableperformanceinsights

    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

    Remarks

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow

    Tags

    The tags to be assigned to the instance.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    Remarks

    You can assign up to 10 tags to an instance.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags

    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>

    Overrides

    Implements

    Constructs.IConstruct