interface IDatabaseCluster
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DocDB.IDatabaseCluster |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#IDatabaseCluster |
![]() | software.amazon.awscdk.services.docdb.IDatabaseCluster |
![]() | aws_cdk.aws_docdb.IDatabaseCluster |
![]() | aws-cdk-lib » aws_docdb » IDatabaseCluster |
Implemented by
Database
Obtainable from
Database
.fromDatabaseClusterAttributes()
Create a clustered database with a given number of instances.
Properties
Name | Type | Description |
---|---|---|
cluster | Endpoint | The endpoint to use for read/write operations. |
cluster | string | Identifier of the cluster. |
cluster | Endpoint | Endpoint to use for load-balanced read-only operations. |
connections | Connections | The network connections associated with this resource. |
env | Resource | The environment this resource belongs to. |
instance | Endpoint [] | Endpoints which address each individual replica. |
instance | string[] | Identifiers of the replicas. |
node | Node | The tree node. |
security | string | The security group for this database cluster. |
stack | Stack | The stack in which this resource is defined. |
clusterEndpoint
Type:
Endpoint
The endpoint to use for read/write operations.
clusterIdentifier
Type:
string
Identifier of the cluster.
clusterReadEndpoint
Type:
Endpoint
Endpoint to use for load-balanced read-only operations.
connections
Type:
Connections
The network connections associated with this resource.
env
Type:
Resource
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.
instanceEndpoints
Type:
Endpoint
[]
Endpoints which address each individual replica.
instanceIdentifiers
Type:
string[]
Identifiers of the replicas.
node
Type:
Node
The tree node.
securityGroupId
Type:
string
The security group for this database cluster.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
as | Renders the target specifications. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
asSecretAttachmentTarget()
public asSecretAttachmentTarget(): SecretAttachmentTargetProps
Returns
Renders the target specifications.