CfnDBInstanceProps

class aws_cdk.aws_docdb.CfnDBInstanceProps(*, db_cluster_identifier, db_instance_class, auto_minor_version_upgrade=None, availability_zone=None, ca_certificate_identifier=None, certificate_rotation_restart=None, db_instance_identifier=None, enable_performance_insights=None, preferred_maintenance_window=None, tags=None)

Bases: object

Properties for defining a CfnDBInstance.

Parameters:

db_cluster_identifier (str) – The identifier of the cluster that the instance will belong to.
db_instance_class (str) – The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster’s service.
auto_minor_version_upgrade (Union[bool, IResolvable, None]) – This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. Default: false
availability_zone (Optional[str]) – The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint’s AWS Region . Example: us-east-1d
ca_certificate_identifier (Optional[str]) – The CA certificate identifier to use for the DB instance’s server certificate. For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .
certificate_rotation_restart (Union[bool, IResolvable, None]) –
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. 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. .. epigraph:: 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 .
db_instance_identifier (Optional[str]) – The instance identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - The first character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
enable_performance_insights (Union[bool, IResolvable, None]) – A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
preferred_maintenance_window (Optional[str]) – The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_docdb as docdb

cfn_dBInstance_props = docdb.CfnDBInstanceProps(
    db_cluster_identifier="dbClusterIdentifier",
    db_instance_class="dbInstanceClass",

    # the properties below are optional
    auto_minor_version_upgrade=False,
    availability_zone="availabilityZone",
    ca_certificate_identifier="caCertificateIdentifier",
    certificate_rotation_restart=False,
    db_instance_identifier="dbInstanceIdentifier",
    enable_performance_insights=False,
    preferred_maintenance_window="preferredMaintenanceWindow",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auto_minor_version_upgrade

This parameter does not apply to Amazon DocumentDB.

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

availability_zone

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

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

ca_certificate_identifier

The CA certificate identifier to use for the DB instance’s server certificate.

For more information, 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-cacertificateidentifier

certificate_rotation_restart

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

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

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

db_cluster_identifier

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

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

db_instance_class

The compute and memory capacity of the instance;

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

db_instance_identifier

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

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

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

enable_performance_insights

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

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

preferred_maintenance_window

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

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

tags

The tags to be assigned to the instance.

You can assign up to 10 tags to an instance.

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