software.amazon.awscdk.services.rds

Class ServerlessCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.rds.ServerlessCluster

All Implemented Interfaces:

IDependable, IResource, IConnectable, IServerlessCluster, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:48.918Z")
 @Stability(value=Stable)
public class ServerlessCluster
extends Resource
implements IServerlessCluster

Create an Aurora Serverless Cluster.

Example:

 Vpc vpc;
 Code code;
 ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AnotherCluster")
         .engine(DatabaseClusterEngine.AURORA_MYSQL)
         .vpc(vpc) // this parameter is optional for serverless Clusters
         .enableDataApi(true)
         .build();
 Function fn = Function.Builder.create(this, "MyFunction")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(code)
         .environment(Map.of(
                 "CLUSTER_ARN", cluster.getClusterArn(),
                 "SECRET_ARN", cluster.getSecret().getSecretArn()))
         .build();
 cluster.grantDataApiAccess(fn);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerlessCluster.Builder A fluent builder for ServerlessCluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IServerlessCluster

IServerlessCluster.Jsii$Default, IServerlessCluster.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ServerlessCluster(software.constructs.Construct scope, String id, ServerlessClusterProps props)
protected	ServerlessCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ServerlessCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
SecretRotation	addRotationMultiUser(String id, RotationMultiUserOptions options) Adds the multi user rotation to this cluster.
SecretRotation	addRotationSingleUser() Adds the single user rotation of the master password to this cluster.
SecretRotation	addRotationSingleUser(RotationSingleUserOptions options) Adds the single user rotation of the master password to this cluster.
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the secret attachment target specifications.
static IServerlessCluster	fromServerlessClusterAttributes(software.constructs.Construct scope, String id, ServerlessClusterAttributes attrs) Import an existing DatabaseCluster from properties.
String	getClusterArn() The ARN of the cluster.
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
String	getClusterIdentifier() Identifier of the cluster.
Endpoint	getClusterReadEndpoint() The endpoint to use for read/write operations.
Connections	getConnections() Access to the network connections.
protected Boolean	getEnableDataApi()
protected CfnDBClusterProps	getNewCfnProps()
ISecret	getSecret() The secret attached to this cluster.
protected List<ISecurityGroup>	getSecurityGroups()
Grant	grantDataApiAccess(IGrantable grantee) Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present.
protected void	setEnableDataApi(Boolean value)

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ServerlessCluster

protected ServerlessCluster(software.amazon.jsii.JsiiObjectRef objRef)

ServerlessCluster

protected ServerlessCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ServerlessCluster

@Stability(value=Stable)
public ServerlessCluster(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  ServerlessClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromServerlessClusterAttributes

@Stability(value=Stable)
 @NotNull
public static IServerlessCluster fromServerlessClusterAttributes(@NotNull
                                                                                                    software.constructs.Construct scope,
                                                                                                    @NotNull
                                                                                                    String id,
                                                                                                    @NotNull
                                                                                                    ServerlessClusterAttributes attrs)

Import an existing DatabaseCluster from properties.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addRotationMultiUser

@Stability(value=Stable)
 @NotNull
public SecretRotation addRotationMultiUser(@NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              RotationMultiUserOptions options)

Adds the multi user rotation to this cluster.

Parameters:

id - This parameter is required.

options - This parameter is required.

addRotationSingleUser

@Stability(value=Stable)
 @NotNull
public SecretRotation addRotationSingleUser(@Nullable
                                                                               RotationSingleUserOptions options)

Adds the single user rotation of the master password to this cluster.

Parameters:

options -

addRotationSingleUser

@Stability(value=Stable)
 @NotNull
public SecretRotation addRotationSingleUser()

Adds the single user rotation of the master password to this cluster.

asSecretAttachmentTarget

@Stability(value=Stable)
 @NotNull
public SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

grantDataApiAccess

@Stability(value=Stable)
 @NotNull
public Grant grantDataApiAccess(@NotNull
                                                                   IGrantable grantee)

Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present.

Specified by:

grantDataApiAccess in interface IServerlessCluster

Parameters:

grantee - The principal to grant access to. This parameter is required.

getClusterArn

@Stability(value=Stable)
 @NotNull
public String getClusterArn()

The ARN of the cluster.

Specified by:

getClusterArn in interface IServerlessCluster

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
public Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IServerlessCluster

getClusterIdentifier

@Stability(value=Stable)
 @NotNull
public String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IServerlessCluster

getClusterReadEndpoint

@Stability(value=Stable)
 @NotNull
public Endpoint getClusterReadEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterReadEndpoint in interface IServerlessCluster

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Access to the network connections.

Specified by:

getConnections in interface IConnectable

getNewCfnProps

@Stability(value=Stable)
 @NotNull
protected CfnDBClusterProps getNewCfnProps()

getSecurityGroups

@Stability(value=Stable)
 @NotNull
protected List<ISecurityGroup> getSecurityGroups()

getSecret

@Stability(value=Stable)
 @Nullable
public ISecret getSecret()

The secret attached to this cluster.

getEnableDataApi

@Stability(value=Stable)
 @Nullable
protected Boolean getEnableDataApi()

setEnableDataApi

@Stability(value=Stable)
protected void setEnableDataApi(@Nullable
                                                         Boolean value)