DatabaseInstanceBase L2 construct
A new or imported database instance.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
declare const instanceEngine: rds.IInstanceEngine;
declare const securityGroup: ec2.SecurityGroup;
const databaseInstanceBase = rds.DatabaseInstanceBase.fromDatabaseInstanceAttributes(this, 'MyDatabaseInstanceBase', {
instanceEndpointAddress: 'instanceEndpointAddress',
instanceIdentifier: 'instanceIdentifier',
port: 123,
securityGroups: [securityGroup],
// the properties below are optional
engine: instanceEngine,
instanceResourceId: 'instanceResourceId',
});
Initializer
new DatabaseInstanceBase(scope: Construct, id: string, props?: ResourceProps)
DatabaseInstanceBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
new DatabaseInstanceBase(Construct scope, String id, ResourceProps props)
new DatabaseInstanceBase(Construct scope, string id, ResourceProps? props = null)
NewDatabaseInstanceBase(Scope Construct, Id *string, Props ResourceProps)
Construct Props
default
Default: the resource is in the same account as the stack it belongs to
environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.
Cannot be supplied together with either account or region.
default
Default: take environment from account, region parameters, or use Stack environment.
physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#notes · default
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
Default: The physical name will be allocated by CloudFormation at deployment time
default
Default: the resource is in the same region as the stack it belongs to
Properties
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#dbInstanceEndpointAddressstringdb_instance_endpoint_addressstrdbInstanceEndpointAddressStringDbInstanceEndpointAddressstringDbInstanceEndpointAddress*stringrequired#dbInstanceEndpointPortstringdb_instance_endpoint_portstrdbInstanceEndpointPortStringDbInstanceEndpointPortstringDbInstanceEndpointPort*stringrequired#dbInstanceRefDBInstanceReferencedb_instance_refDBInstanceReferencedbInstanceRefDBInstanceReferenceDbInstanceRefDBInstanceReferenceDbInstanceRefDBInstanceReferencerequired#engineIInstanceEngineengineIInstanceEngineengineIInstanceEngineEngineIInstanceEngineEngineIInstanceEngine#May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#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.
instanceEndpointEndpointinstance_endpointEndpointinstanceEndpointEndpointInstanceEndpointEndpointInstanceEndpointEndpointrequired#instanceIdentifierstringinstance_identifierstrinstanceIdentifierStringInstanceIdentifierstringInstanceIdentifier*stringrequired#instanceResourceIdstringinstance_resource_idstrinstanceResourceIdStringInstanceResourceIdstringInstanceResourceId*string#This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
Methods
addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxydef add_proxy(self, id: str, options: DatabaseProxyOptions) -> DatabaseProxypublic DatabaseProxy addProxy(String id, DatabaseProxyOptions options)public DatabaseProxy AddProxy(string id, DatabaseProxyOptions options)func AddProxy(Id *string, Options DatabaseProxyOptions) DatabaseProxy#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)#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)#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).
asSecretAttachmentTarget(): SecretAttachmentTargetPropsdef as_secret_attachment_target(self, ) -> SecretAttachmentTargetPropspublic SecretAttachmentTargetProps asSecretAttachmentTarget()public SecretAttachmentTargetProps AsSecretAttachmentTarget()func AsSecretAttachmentTarget() SecretAttachmentTargetProps#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#fromLookup(scope: Construct, id: string, options: DatabaseInstanceLookupOptions): IDatabaseInstance@staticmethod def from_lookup(scope: Construct, id: str, options: DatabaseInstanceLookupOptions) -> IDatabaseInstancepublic static IDatabaseInstance fromLookup(Construct scope, String id, DatabaseInstanceLookupOptions options)public static IDatabaseInstance FromLookup(Construct scope, string id, DatabaseInstanceLookupOptions options)func FromLookup(Scope Construct, Id *string, Options DatabaseInstanceLookupOptions) IDatabaseInstancestatic#grantConnect(grantee: IGrantable, dbUser?: string): Grantdef grant_connect(self, grantee: IGrantable, db_user: typing.Optional[str] = None) -> Grantpublic Grant grantConnect(IGrantable grantee, String dbUser)public Grant GrantConnect(IGrantable grantee, string? dbUser = null)func GrantConnect(Grantee IGrantable, DbUser *string) Grant#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#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#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#metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#metricCPUUtilization(props?: MetricOptions): Metricdef metric_cpu_utilization(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCPUUtilization(MetricOptions props)public Metric MetricCPUUtilization(MetricOptions? props = null)func MetricCPUUtilization(Props MetricOptions) Metric#Average over 5 minutes
metricDatabaseConnections(props?: MetricOptions): Metricdef metric_database_connections(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDatabaseConnections(MetricOptions props)public Metric MetricDatabaseConnections(MetricOptions? props = null)func MetricDatabaseConnections(Props MetricOptions) Metric#Average over 5 minutes
metricFreeableMemory(props?: MetricOptions): Metricdef metric_freeable_memory(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFreeableMemory(MetricOptions props)public Metric MetricFreeableMemory(MetricOptions? props = null)func MetricFreeableMemory(Props MetricOptions) Metric#Average over 5 minutes
metricFreeStorageSpace(props?: MetricOptions): Metricdef metric_free_storage_space(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFreeStorageSpace(MetricOptions props)public Metric MetricFreeStorageSpace(MetricOptions? props = null)func MetricFreeStorageSpace(Props MetricOptions) Metric#Average over 5 minutes
metricReadIOPS(props?: MetricOptions): Metricdef metric_read_iops(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricReadIOPS(MetricOptions props)public Metric MetricReadIOPS(MetricOptions? props = null)func MetricReadIOPS(Props MetricOptions) Metric#Average over 5 minutes
metricWriteIOPS(props?: MetricOptions): Metricdef metric_write_iops(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricWriteIOPS(MetricOptions props)public Metric MetricWriteIOPS(MetricOptions? props = null)func MetricWriteIOPS(Props MetricOptions) Metric#Average over 5 minutes
onEvent(id: string, options?: OnEventOptions): Ruledef on_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onEvent(String id, OnEventOptions options)public Rule OnEvent(string id, OnEventOptions? options = null)func OnEvent(Id *string, Options OnEventOptions) Rule#Use rule.addEventPattern(pattern) to specify a filter.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.