The endpoint to use for read/write operations.
Identifier of the cluster.
The endpoint to use for read/write operations.
Access to the network connections.
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.
The construct tree node associated with this construct.
Returns 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 secret attached to this cluster.
The stack in which this resource is defined.
The ARN of the cluster.
Called 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 it's absolute name/arn.
Adds the multi user rotation to this cluster.
Adds the single user rotation of the master password to this cluster.
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.DELETE), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
Renders the secret attachment target specifications.
Get params for connecting via data API. Make sure you set enableDataApi: true or call grantDataApiAccess()
Returns 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.
The format of the ARN of this resource.
Returns 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.
Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present.
The principal to grant access to.
Generate a database connection string (DSN).
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
The synthesis session.
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
An array of validation error messages, or an empty array if the construct is valid.
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
The synthesis session.
Returns a string representation of this construct.
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
An array of validation error messages, or an empty array if the construct is valid.
Import an existing DatabaseCluster from properties.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
Generated using TypeDoc
Quickest and easiest way to get a Postgres database. Uses Aurora Serverless. Generates secret. and https://docs.aws.amazon.com/cdk/api/latest/docs/aws-rds-readme.html#data-api