Interface ICfnDBInstanceProps

Properties for defining a CfnDBInstance.

Namespace: Amazon.CDK.AWS.DocDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDBInstanceProps

Syntax (vb)

Public Interface ICfnDBInstanceProps

Remarks

See: 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;

var cfnDBInstanceProps = 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

Properties

AutoMinorVersionUpgrade	This parameter does not apply to Amazon DocumentDB.
AvailabilityZone	The Amazon EC2 Availability Zone that the instance is created in.
CaCertificateIdentifier	The identifier of the CA certificate for this DB instance.
CertificateRotationRestart	Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
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	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	The tags to be assigned to the instance.

Properties

AutoMinorVersionUpgrade

This parameter does not apply to Amazon DocumentDB.

virtual object AutoMinorVersionUpgrade { get; }

Property Value

System.Object

Remarks

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

Default: false

See: 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.

virtual string AvailabilityZone { get; }

Property Value

System.String

Remarks

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

Example: us-east-1d

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

CaCertificateIdentifier

The identifier of the CA certificate for this DB instance.

virtual string CaCertificateIdentifier { get; }

Property Value

System.String

Remarks

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

CertificateRotationRestart

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

virtual object CertificateRotationRestart { get; }

Property Value

System.Object

Remarks

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

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

DbClusterIdentifier

The identifier of the cluster that the instance will belong to.

string DbClusterIdentifier { get; }

Property Value

System.String

Remarks

See: 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;

string DbInstanceClass { get; }

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.

See: 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.

virtual string DbInstanceIdentifier { get; }

Property Value

System.String

Remarks

Constraints:

Example: mydbinstance

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

EnablePerformanceInsights

A value that indicates whether to enable Performance Insights for the DB Instance.

virtual object EnablePerformanceInsights { get; }

Property Value

System.Object

Remarks

For more information, see Using Amazon Performance Insights .

See: 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).

virtual string PreferredMaintenanceWindow { get; }

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.

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