ReadonlycloudwatchReadonlyconnectionsAccess to network connections.
ReadonlydbReadonlydbProtected OptionalenableOptional ReadonlyengineReadonlyenvThe 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.
ReadonlyidThe ID of the construct with the App suffix.
This should be used in place of id when trying to reference the construct.
ReadonlyinstanceReadonlyinstanceOptional ReadonlyinstanceProtected ReadonlyinstanceProtected ReadonlynewReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationOptional ReadonlysecretThe AWS Secrets Manager secret attached to the instance.
Protected ReadonlysourceReadonlystackThe stack in which this resource is defined.
ReadonlyvpcThe VPC where this database instance is deployed.
Protected Optional ReadonlyvpcStatic ReadonlyPROPERTY_Uniquely identifies this class.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Add a new db proxy to this instance.
Adds the multi user rotation to this instance.
Adds the single user rotation of the master password to this instance.
Optionaloptions: RotationSingleUserOptionsthe options for the rotation, if you want to override the defaults
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).
Renders the secret attachment target specifications.
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Grant the given identity connection access to the database.
the Principal to grant the permissions to
OptionaldbUser: stringthe name of the database user to allow connecting as to the db instance, or the default database user, obtained from the Secret, if not specified
Return the given named metric for this DBInstance
Optionalprops: MetricOptionsThe percentage of CPU utilization.
Average over 5 minutes
Optionalprops: MetricOptionsThe number of database connections in use.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of available random access memory.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of available storage space.
Average over 5 minutes
Optionalprops: MetricOptionsThe average number of disk write I/O operations per second.
Average over 5 minutes
Optionalprops: MetricOptionsThe average number of disk read I/O operations per second.
Average over 5 minutes
Optionalprops: MetricOptionsDefines a CloudWatch event rule which triggers for instance events. Use
rule.addEventPattern(pattern) to specify a filter.
Optionaloptions: OnEventOptionsProtectedsetReturns a string representation of an object.
StaticfromStaticfromStaticisChecks if x is a construct.
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.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
The log group is created when
cloudwatchLogsExportsis set.Each export value will create a separate log group.