ReadonlycloudwatchThe log group is created when cloudwatchLogsExports is set.
Each export value will create a separate log group.
ReadonlyclusterThe endpoint to use for read/write operations
ReadonlyclusterIdentifier of the cluster
ReadonlyclusterEndpoint to use for load-balanced read-only operations.
ReadonlyclusterThe immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.
This AWS Region-unique identifier is used in things like IAM authentication policies.
ReadonlyconnectionsAccess to the network connections
Optional ReadonlydatabaseThe database insights mode.
Protected OptionalenableOptional ReadonlyengineThe engine for this Cluster. Never undefined.
Protected OptionalhasReadonlyinstanceEndpoints which address each individual replica.
ReadonlyinstanceIdentifiers of the replicas
Optional ReadonlymonitoringThe IAM role for the enhanced monitoring.
ReadonlymultiApplication for multi user rotation to this cluster.
Protected ReadonlynewReadonlynodeThe tree node.
Optional ReadonlyperformanceThe AWS KMS key for encryption of Performance Insights data.
Optional ReadonlyperformanceThe amount of time, in days, to retain Performance Insights data.
ReadonlyperformanceWhether Performance Insights is enabled at cluster level.
Optional ReadonlysecretThe secret attached to this cluster
Protected ReadonlysecurityProtected Optional ReadonlyserverlessProtected ReadonlyserverlessProtected ReadonlyserverlessReadonlysingleApplication for single user rotation of the master password to this cluster.
Protected ReadonlysubnetReadonlyvpcThe VPC network to place the cluster in.
Optional ReadonlyvpcThe cluster's subnets.
Static ReadonlyPROPERTY_Uniquely identifies this class.
The ARN of the cluster
A reference to this database cluster
The environment this resource belongs to.
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.
ProtectedphysicalReturns 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 CloudFormationThe stack in which this resource is defined.
ProtectedsubnetProtected_InternalCreate cluster instances
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 cluster.
Adds the multi user rotation to this cluster. See Alternating users rotation strategy
Adds the single user rotation of the master password to this cluster. See Single user rotation strategy
Optionaloptions: RotationSingleUserOptionsOverride the cross-stack reference strength for this resource.
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.
The reference strength to use for this resource.
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.
[disable-awslint:no-grants]
Grant the given identity to access the Data API.
[disable-awslint:no-grants]
Return the given named metric for this DBCluster
Optionalprops: MetricOptionsThis value is represented as a percentage. It's calculated as the value of the ServerlessDatabaseCapacity metric divided by the maximum ACU value of the DB cluster.
If this metric approaches a value of 100.0, the DB instance has scaled up as high as it can. Consider increasing the maximum ACU setting for the cluster.
Optionalprops: MetricOptionsThe percentage of CPU utilization.
Average over 5 minutes
Optionalprops: MetricOptionsThe number of database connections in use.
Average over 5 minutes
Optionalprops: MetricOptionsThe average number of deadlocks in the database per second.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of time that the instance has been running, in seconds.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of available random access memory, in bytes.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of local storage available, in bytes.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of network throughput received from clients by each instance, in bytes per second.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of network throughput sent to clients by each instance, in bytes per second.
Average over 5 minutes
Optionalprops: MetricOptionsAs a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster.
Optionalprops: MetricOptionsThe total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
Average over 5 minutes
Optionalprops: MetricOptionsThe total amount of backup storage in bytes for which you are billed.
Average over 5 minutes
Optionalprops: MetricOptionsThe amount of storage used by your Aurora DB instance, in bytes.
Average over 5 minutes
Optionalprops: MetricOptionsReturns a string representation of this construct.
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.
The mixins to apply
This construct for chaining
StaticfromStaticfromLookup an existing DatabaseCluster using clusterIdentifier.
StaticisChecks 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
A construct for the creation of a compliant Rds Serverless Cluster Specifically, the construct ensures the following: