- class aws_cdk.aws_docdb.DatabaseInstance(scope, id, *, cluster, instance_type, auto_minor_version_upgrade=None, availability_zone=None, db_instance_name=None, preferred_maintenance_window=None, removal_policy=None)
A database instance.
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_docdb as docdb import aws_cdk.aws_ec2 as ec2 import aws_cdk.core as cdk # database_cluster: docdb.DatabaseCluster # instance_type: ec2.InstanceType database_instance = docdb.DatabaseInstance(self, "MyDatabaseInstance", cluster=database_cluster, instance_type=instance_type, # the properties below are optional auto_minor_version_upgrade=False, availability_zone="availabilityZone", db_instance_name="dbInstanceName", preferred_maintenance_window="preferredMaintenanceWindow", removal_policy=cdk.RemovalPolicy.DESTROY )
IDatabaseCluster) – The DocumentDB database cluster the instance should launch into.
InstanceType) – The name of the compute and memory capacity classes.
bool]) – Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true
str]) – The name of the Availability Zone where the DB instance will be located. Default: - no preference
str]) – A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. Default: - a CloudFormation generated name
str]) – The weekly time range (in UTC) during which system maintenance can occur. Format:
ddd:hh24:mi-ddd:hh24:miConstraint: 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
RemovalPolicy]) – The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. Default: RemovalPolicy.Retain
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (
- Return type
Returns a string representation of this construct.
- Return type
The instance’s database cluster.
The instance endpoint address.
The instance endpoint port.
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.
The instance arn.
The instance endpoint.
The instance identifier.
The construct tree node associated with this construct.
The stack in which this resource is defined.
- classmethod from_database_instance_attributes(scope, id, *, instance_endpoint_address, instance_identifier, port)
Import an existing database instance.
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Return type