DatabaseInstanceProps

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

Bases: object

Construction properties for a DatabaseInstanceNew.

Parameters
  • 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

Attributes

auto_minor_version_upgrade

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

default :default: true

stability :stability: experimental

Return type

Optional[bool]

availability_zone

The name of the Availability Zone where the DB instance will be located.

default :default: - no preference

stability :stability: experimental

Return type

Optional[str]

cluster

The DocumentDB database cluster the instance should launch into.

stability :stability: experimental

Return type

IDatabaseCluster

db_instance_name

A name for the DB instance.

If you specify a name, AWS CloudFormation converts it to lowercase.

default :default: - a CloudFormation generated name

stability :stability: experimental

Return type

Optional[str]

instance_class

The name of the compute and memory capacity classes.

stability :stability: experimental

Return type

InstanceType

preferred_maintenance_window

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 :default:

stability :stability: experimental

Return type

Optional[str]

removal_policy

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

default :default: RemovalPolicy.Retain

stability :stability: experimental

Return type

Optional[RemovalPolicy]