ICluster

class aws_cdk.aws_dsql_alpha.ICluster(*args, **kwargs)

Bases: IResource, Protocol

(experimental) Represents an Aurora DSQL cluster.

Stability:

experimental

Methods

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy)

Return type:

None

grant(grantee, *actions)

(experimental) Grant the given identity the specified actions.

Parameters:
  • grantee (IGrantable) – the identity to be granted the actions.

  • actions (str) – the data-access actions.

See:

Return type:

Grant

https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-authorization.html

[disable-awslint:no-grants] :stability: experimental

grant_connect(grantee)

(experimental) Grant the given identity permission to connect to the database.

[disable-awslint:no-grants]

Parameters:

grantee (IGrantable)

Stability:

experimental

Return type:

Grant

grant_connect_admin(grantee)

(experimental) Grant the given identity permission to connect to the database with admin role.

[disable-awslint:no-grants]

Parameters:

grantee (IGrantable)

Stability:

experimental

Return type:

Grant

with_(*mixins)

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.

Parameters:

mixins (IMixin) – The mixins to apply.

Return type:

IConstruct

Returns:

This construct for chaining

Attributes

cluster_arn

(experimental) Arn of the cluster.

Stability:

experimental

Attribute:

ResourceArn

cluster_endpoint

(experimental) Connection endpoint for the cluster.

Stability:

experimental

Attribute:

Endpoint

cluster_identifier

(experimental) Identifier of the cluster.

Stability:

experimental

Attribute:

Identifier

env

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

The tree node.

stack

The stack in which this resource is defined.

vpc_endpoint_service_name

(experimental) VPC endpoint service name for the cluster.

Stability:

experimental

Attribute:

VpcEndpointServiceName