DatabaseInstance

class aws_cdk.aws_docdb.DatabaseInstance(scope, id, *, cluster, instance_class, auto_minor_version_upgrade=None, availability_zone=None, db_instance_name=None, preferred_maintenance_window=None, removal_policy=None)

Bases: aws_cdk.core.Resource

A database instance.

stability :stability: experimental resource: :resource:: AWS::DocDB::DBInstance

__init__(scope, id, *, cluster, instance_class, auto_minor_version_upgrade=None, availability_zone=None, db_instance_name=None, preferred_maintenance_window=None, removal_policy=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • cluster (IDatabaseCluster) – The DocumentDB database cluster the instance should launch into.

  • instance_class (InstanceType) – The name of the compute and memory capacity classes.

  • auto_minor_version_upgrade (Optional[bool]) – Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true

  • availability_zone (Optional[str]) – The name of the Availability Zone where the DB instance will be located. Default: - no preference

  • db_instance_name (Optional[str]) – A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. Default: - a CloudFormation generated name

  • preferred_maintenance_window (Optional[str]) – The weekly time range (in UTC) during which system maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window Default: - 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. To see the time blocks available, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#maintenance-window

  • removal_policy (Optional[RemovalPolicy]) – The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. Default: RemovalPolicy.Retain

stability :stability: experimental

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

cluster

The instance’s database cluster.

stability :stability: experimental

Return type

IDatabaseCluster

db_instance_endpoint_address

The instance endpoint address.

stability :stability: experimental inheritdoc: :inheritdoc:: true

Return type

str

db_instance_endpoint_port

The instance endpoint port.

stability :stability: experimental inheritdoc: :inheritdoc:: true

Return type

str

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

instance_arn

The instance arn.

stability :stability: experimental

Return type

str

instance_endpoint

The instance endpoint.

stability :stability: experimental inheritdoc: :inheritdoc:: true

Return type

Endpoint

instance_identifier

The instance identifier.

stability :stability: experimental inheritdoc: :inheritdoc:: true

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_database_instance_attributes(scope, id, *, instance_endpoint_address, instance_identifier, port)

Import an existing database instance.

Parameters
  • scope (Construct) –

  • id (str) –

  • instance_endpoint_address (str) – The endpoint address.

  • instance_identifier (str) – The instance identifier.

  • port (Union[int, float]) – The database port.

stability :stability: experimental

Return type

IDatabaseInstance

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool