interface IDatabaseCluster
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Neptune.Alpha.IDatabaseCluster |
![]() | github.com/aws/aws-cdk-go/awscdkneptunealpha/v2#IDatabaseCluster |
![]() | software.amazon.awscdk.services.neptune.alpha.IDatabaseCluster |
![]() | aws_cdk.aws_neptune_alpha.IDatabaseCluster |
![]() | @aws-cdk/aws-neptune-alpha ยป 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. |
cluster | string | Resource identifier of the cluster. |
connections | Connections | The network connections associated with this resource. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
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.
clusterResourceIdentifier
Type:
string
Resource identifier of the cluster.
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.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant(grantee, ...actions) | Grant the given identity the specified actions. |
grant | Grant the given identity connection access to the database. |
metric(metricName, props?) | Return the given named metric associated with this DatabaseCluster instance. |
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
).
grant(grantee, ...actions)
public grant(grantee: IGrantable, ...actions: string[]): Grant
Parameters
- grantee
IGrantable
โ the identity to be granted the actions. - actions
string
โ the data-access actions.
Returns
Grant the given identity the specified actions.
See also: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html
grantConnect(grantee)
public grantConnect(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity connection access to the database.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric associated with this DatabaseCluster instance.
See also: https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html