interface ICluster
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.DSQL.Alpha.ICluster |
 Go | github.com/aws/aws-cdk-go/awscdkdsqlalpha/v2#ICluster |
 Java | software.amazon.awscdk.services.dsql.alpha.ICluster |
 Python | aws_cdk.aws_dsql_alpha.ICluster |
 TypeScript (source) | @aws-cdk/aws-dsql-alpha » ICluster |
Implements
IDependable, IConstruct, IEnvironment, IResource
Implemented by
Cluster
Obtainable from
Cluster.fromClusterAttributes()
Represents an Aurora DSQL cluster.
Properties
| Name | Type | Description |
|---|---|---|
| cluster | string | Arn of the cluster. |
| cluster | string | Connection endpoint for the cluster. |
| cluster | string | Identifier of the cluster. |
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| vpc | string | VPC endpoint service name for the cluster. |
clusterArn
Type:
string
Arn of the cluster.
clusterEndpoint
Type:
string
Connection endpoint for the cluster.
clusterIdentifier
Type:
string
Identifier of the cluster.
env
Type:
Resource
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.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
vpcEndpointServiceName
Type:
string
VPC endpoint service name for the cluster.
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 permission to connect to the database. |
| grant | Grant the given identity permission to connect to the database with admin role. |
| with(...mixins) | Applies one or more mixins to this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
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.
[disable-awslint:no-grants]](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-authorization.html
[disable-awslint:no-grants])
grantConnect(grantee)
public grantConnect(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permission to connect to the database.
[disable-awslint:no-grants]
grantConnectAdmin(grantee)
public grantConnectAdmin(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permission to connect to the database with admin role.
[disable-awslint:no-grants]
with(...mixins)
public with(...mixins: IMixin[]): IConstruct
Parameters
- mixins
IMixin— The mixins to apply.
Returns
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.