@aws-cdk/aws-dsql-alpha.Cluster

Experimental

@aws-cdk/aws-dsql-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Cluster L2 construct

Create an Aurora DSQL cluster.

Construct›Resource›Cluster

implements

• ICluster,
• IResource,
• IEnvironmentAware,
• IConstruct,
• IDependable

Stability

Experimental

CloudFormation

AWS::DSQL::Cluster

L1 type

CfnCluster

Source

lib/cluster.ts

Example

const cluster = new dsql.Cluster(this, 'Cluster', {
  clusterName: 'my-dsql-cluster',
  deletionProtection: true,
});

cluster = dsql.Cluster(self, "Cluster",
    cluster_name="my-dsql-cluster",
    deletion_protection=True
)

Cluster cluster = Cluster.Builder.create(this, "Cluster")
        .clusterName("my-dsql-cluster")
        .deletionProtection(true)
        .build();

// Install: dotnet add package Amazon.CDK.AWS.DSQL.Alpha
var cluster = new Cluster(this, "Cluster", new ClusterProps {
    ClusterName = "my-dsql-cluster",
    DeletionProtection = true
});

// Install: go get github.com/aws/aws-cdk-go/awscdkdsqlalpha/v2
cluster := dsql.NewCluster(this, jsii.String("Cluster"), &ClusterProps{
	ClusterName: jsii.String("my-dsql-cluster"),
	DeletionProtection: jsii.Boolean(true),
})

Initializer

new Cluster(scope: Construct, id: string, props?: ClusterProps)

Cluster(scope: Construct, id: str, props: typing.Optional[ClusterProps] = None)

new Cluster(Construct scope, String id, ClusterProps props)

new Cluster(Construct scope, string id, ClusterProps? props = null)

NewCluster(Scope Construct, Id *string, Props ClusterProps)

Construct Props

clusterName?optionalstringcluster_name?optionalstrclusterName?optionalStringClusterName?optionalstringClusterName?optional*string#

The name of the DSQL cluster.

Default: No name specified.

This is applied via the Name tag.

deletionProtection?optionalbooleandeletion_protection?optionalbooldeletionProtection?optionalBooleanDeletionProtection?optionalboolDeletionProtection?optional*bool#

Specifies whether this cluster can be deleted.

Default: true if removalPolicy is RETAIN, undefined otherwise.

If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted.

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy#

The removal policy to apply when the cluster is removed or replaced during a stack update, or when the stack is deleted.

Default: Retain cluster.

Properties

clusterArnstringcluster_arnstrclusterArnStringClusterArnstringClusterArn*string#

Arn of the cluster.

clusterEndpointstringcluster_endpointstrclusterEndpointStringClusterEndpointstringClusterEndpoint*string#

Connection endpoint for the cluster.

clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*string#

Identifier of the cluster.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

vpcEndpointServiceNamestringvpc_endpoint_service_namestrvpcEndpointServiceNameStringVpcEndpointServiceNamestringVpcEndpointServiceName*string#

VPC endpoint service name for the cluster.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

fromClusterAttributes(scope: Construct, id: string, attrs: ClusterAttributes): ICluster@staticmethod def from_cluster_attributes(scope: Construct, id: str, attrs: ClusterAttributes) -> IClusterpublic static ICluster fromClusterAttributes(Construct scope, String id, ClusterAttributes attrs)public static ICluster FromClusterAttributes(Construct scope, string id, ClusterAttributes attrs)func FromClusterAttributes(Scope Construct, Id *string, Attrs ClusterAttributes) IClusterstatic#

Import an existing Cluster from attributes.

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#

Grant the given identity the specified actions.

grantConnect(grantee: IGrantable): Grantdef grant_connect(self, grantee: IGrantable) -> Grantpublic Grant grantConnect(IGrantable grantee)public Grant GrantConnect(IGrantable grantee)func GrantConnect(Grantee IGrantable) Grant#

Grant the given identity permission to connect to the database.

[disable-awslint:no-grants]

grantConnectAdmin(grantee: IGrantable): Grantdef grant_connect_admin(self, grantee: IGrantable) -> Grantpublic Grant grantConnectAdmin(IGrantable grantee)public Grant GrantConnectAdmin(IGrantable grantee)func GrantConnectAdmin(Grantee IGrantable) Grant#

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

[disable-awslint:no-grants]

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

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. Use multiple with() calls if subsequent mixins should apply to added constructs.