DatabaseInstance L2 construct
A database instance.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_docdb as docdb } from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
import { aws_docdb as interfaces_docdb } from 'aws-cdk-lib/interfaces';
declare const caCertificate: rds.CaCertificate;
declare const dBClusterRef: interfaces_docdb.IDBClusterRef;
declare const instanceType: ec2.InstanceType;
const databaseInstance = new docdb.DatabaseInstance(this, 'MyDatabaseInstance', {
cluster: dBClusterRef,
instanceType: instanceType,
// the properties below are optional
autoMinorVersionUpgrade: false,
availabilityZone: 'availabilityZone',
caCertificate: caCertificate,
dbInstanceName: 'dbInstanceName',
enablePerformanceInsights: false,
preferredMaintenanceWindow: 'preferredMaintenanceWindow',
removalPolicy: cdk.RemovalPolicy.DESTROY,
});
python
# 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
from aws_cdk.interfaces import aws_docdb as interfaces_docdb
# ca_certificate: rds.CaCertificate
# d_b_cluster_ref: interfaces_docdb.IDBClusterRef
# instance_type: ec2.InstanceType
database_instance = docdb.DatabaseInstance(self, "MyDatabaseInstance",
cluster=d_b_cluster_ref,
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
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.docdb.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.rds.*;
import software.amazon.awscdk.interfaces.docdb.*;
CaCertificate caCertificate;
IDBClusterRef dBClusterRef;
InstanceType instanceType;
DatabaseInstance databaseInstance = DatabaseInstance.Builder.create(this, "MyDatabaseInstance")
.cluster(dBClusterRef)
.instanceType(instanceType)
// the properties below are optional
.autoMinorVersionUpgrade(false)
.availabilityZone("availabilityZone")
.caCertificate(caCertificate)
.dbInstanceName("dbInstanceName")
.enablePerformanceInsights(false)
.preferredMaintenanceWindow("preferredMaintenanceWindow")
.removalPolicy(RemovalPolicy.DESTROY)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.DocDB;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.RDS;
using Amazon.CDK.Interfaces.DocDB;
CaCertificate caCertificate;
IDBClusterRef dBClusterRef;
InstanceType instanceType;
var databaseInstance = new DatabaseInstance(this, "MyDatabaseInstance", new DatabaseInstanceProps {
Cluster = dBClusterRef,
InstanceType = instanceType,
// the properties below are optional
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
CaCertificate = caCertificate,
DbInstanceName = "dbInstanceName",
EnablePerformanceInsights = false,
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
RemovalPolicy = RemovalPolicy.DESTROY
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var caCertificate CaCertificate
var dBClusterRef IDBClusterRef
var instanceType InstanceType
databaseInstance := awscdk.Aws_docdb.NewDatabaseInstance(this, jsii.String("MyDatabaseInstance"), &DatabaseInstanceProps{
Cluster: dBClusterRef,
InstanceType: instanceType,
// the properties below are optional
AutoMinorVersionUpgrade: jsii.Boolean(false),
AvailabilityZone: jsii.String("availabilityZone"),
CaCertificate: caCertificate,
DbInstanceName: jsii.String("dbInstanceName"),
EnablePerformanceInsights: jsii.Boolean(false),
PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
RemovalPolicy: cdk.RemovalPolicy_DESTROY,
})
Initializer
ts
new DatabaseInstance(scope: Construct, id: string, props: DatabaseInstanceProps)
python
DatabaseInstance(scope: Construct, id: str, props: DatabaseInstanceProps)
java
new DatabaseInstance(Construct scope, String id, DatabaseInstanceProps props)
csharp
new DatabaseInstance(Construct scope, string id, DatabaseInstanceProps props)
go
NewDatabaseInstance(Scope Construct, Id *string, Props DatabaseInstanceProps)
Construct Props
autoMinorVersionUpgradebooleanauto_minor_version_upgradeboolautoMinorVersionUpgradeBooleanAutoMinorVersionUpgradeboolAutoMinorVersionUpgrade*bool= true#Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
availabilityZonestringavailability_zonestravailabilityZoneStringAvailabilityZonestringAvailabilityZone*string= no preference#The name of the Availability Zone where the DB instance will be located.
caCertificateCaCertificateca_certificateCaCertificatecaCertificateCaCertificateCaCertificateCaCertificateCaCertificateCaCertificate= DocumentDB will choose a certifi…#The identifier of the CA certificate for this DB instance.
Specifying or updating this property triggers a reboot.
default
Default: DocumentDB will choose a certificate authority
clusterIDBClusterRefclusterIDBClusterRefclusterIDBClusterRefClusterIDBClusterRefClusterIDBClusterRefrequired#The DocumentDB database cluster the instance should launch into.
dbInstanceNamestringdb_instance_namestrdbInstanceNameStringDbInstanceNamestringDbInstanceName*string= a CloudFormation generated name#A name for the DB instance.
If you specify a name, AWS CloudFormation converts it to lowercase.
enablePerformanceInsightsbooleanenable_performance_insightsboolenablePerformanceInsightsBooleanEnablePerformanceInsightsboolEnablePerformanceInsights*bool= false#A value that indicates whether to enable Performance Insights for the DB Instance.
instanceTypeInstanceTypeinstance_typeInstanceTypeinstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTyperequired#The name of the compute and memory capacity classes.
preferredMaintenanceWindowstringpreferred_maintenance_windowstrpreferredMaintenanceWindowStringPreferredMaintenanceWindowstringPreferredMaintenanceWindow*string= a 30-minute window selected at r…#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: 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
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.Retain#The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
Properties
clusterIDatabaseClusterclusterIDatabaseClusterclusterIDatabaseClusterClusterIDatabaseClusterClusterIDatabaseClusterrequired#The instance's database cluster.
dbInstanceEndpointAddressstringdb_instance_endpoint_addressstrdbInstanceEndpointAddressStringDbInstanceEndpointAddressstringDbInstanceEndpointAddress*stringrequired#The instance endpoint address.
dbInstanceEndpointPortstringdb_instance_endpoint_portstrdbInstanceEndpointPortStringDbInstanceEndpointPortstringDbInstanceEndpointPort*stringrequired#The instance endpoint port.
dbInstanceRefDBInstanceReferencedb_instance_refDBInstanceReferencedbInstanceRefDBInstanceReferenceDbInstanceRefDBInstanceReferenceDbInstanceRefDBInstanceReferencerequired#A reference to this instance.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
The instance arn.
instanceEndpointEndpointinstance_endpointEndpointinstanceEndpointEndpointInstanceEndpointEndpointInstanceEndpointEndpointrequired#The instance endpoint.
instanceIdentifierstringinstance_identifierstrinstanceIdentifierStringInstanceIdentifierstringInstanceIdentifier*stringrequired#The instance identifier.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes): IDatabaseInstance@staticmethod def from_database_instance_attributes(scope: Construct, id: str, attrs: DatabaseInstanceAttributes) -> IDatabaseInstancepublic static IDatabaseInstance fromDatabaseInstanceAttributes(Construct scope, String id, DatabaseInstanceAttributes attrs)public static IDatabaseInstance FromDatabaseInstanceAttributes(Construct scope, string id, DatabaseInstanceAttributes attrs)func FromDatabaseInstanceAttributes(Scope Construct, Id *string, Attrs DatabaseInstanceAttributes) IDatabaseInstancestatic#Import an existing database instance.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct 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 class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof 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 the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.