DatabaseInstance
- class aws_cdk.aws_docdb.DatabaseInstance(scope, id, *, cluster, instance_type, auto_minor_version_upgrade=None, availability_zone=None, ca_certificate=None, db_instance_name=None, enable_performance_insights=None, preferred_maintenance_window=None, removal_policy=None)
Bases:
Resource
A database instance.
- Resource:
AWS::DocDB::DBInstance
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_docdb as docdb from aws_cdk import aws_ec2 as ec2 from aws_cdk import aws_rds as rds # ca_certificate: rds.CaCertificate # 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", ca_certificate=ca_certificate, db_instance_name="dbInstanceName", enable_performance_insights=False, preferred_maintenance_window="preferredMaintenanceWindow", removal_policy=cdk.RemovalPolicy.DESTROY )
- Parameters:
scope (
Construct
) –id (
str
) –cluster (
IDatabaseCluster
) – The DocumentDB database cluster the instance should launch into.instance_type (
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: trueavailability_zone (
Optional
[str
]) – The name of the Availability Zone where the DB instance will be located. Default: - no preferenceca_certificate (
Optional
[CaCertificate
]) – The identifier of the CA certificate for this DB instance. Specifying or updating this property triggers a reboot. Default: - DocumentDB will choose a certificate authoritydb_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 nameenable_performance_insights (
Optional
[bool
]) – A value that indicates whether to enable Performance Insights for the DB Instance. Default: - falsepreferred_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-windowremoval_policy (
Optional
[RemovalPolicy
]) – The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. Default: RemovalPolicy.Retain
Methods
- apply_removal_policy(policy)
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 (RemovalPolicy.RETAIN
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- cluster
The instance’s database cluster.
- db_instance_endpoint_address
The instance endpoint address.
- Inheritdoc:
true
- db_instance_endpoint_port
The instance endpoint port.
- Inheritdoc:
true
- 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.
- instance_arn
The instance arn.
- instance_endpoint
The instance endpoint.
- Inheritdoc:
true
- instance_identifier
The instance identifier.
- Inheritdoc:
true
- node
The tree node.
- stack
The stack in which this resource is defined.
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.
- Return type:
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool