Package 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:
IConstruct, IDependable, IResource, IConnectable, IServerlessCluster, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.259Z") @Stability(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);

  • Constructor Details

    • ServerlessCluster

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

    • ServerlessCluster

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

    • ServerlessCluster

      @Stability(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 Details

    • fromServerlessClusterAttributes

      @Stability(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(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(Stable) @NotNull public SecretRotation addRotationSingleUser(@Nullable RotationSingleUserOptions options)
      Adds the single user rotation of the master password to this cluster.

      Parameters:
      options -

    • addRotationSingleUser

      @Stability(Stable) @NotNull public SecretRotation addRotationSingleUser()
      Adds the single user rotation of the master password to this cluster.

    • asSecretAttachmentTarget

      @Stability(Stable) @NotNull public SecretAttachmentTargetProps asSecretAttachmentTarget()
      Renders the secret attachment target specifications.
      Specified by:
      asSecretAttachmentTarget in interface ISecretAttachmentTarget

    • grantDataApiAccess

      @Stability(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(Stable) @NotNull public String getClusterArn()
      The ARN of the cluster.
      Specified by:
      getClusterArn in interface IServerlessCluster

    • getClusterEndpoint

      @Stability(Stable) @NotNull public Endpoint getClusterEndpoint()
      The endpoint to use for read/write operations.
      Specified by:
      getClusterEndpoint in interface IServerlessCluster

    • getClusterIdentifier

      @Stability(Stable) @NotNull public String getClusterIdentifier()
      Identifier of the cluster.
      Specified by:
      getClusterIdentifier in interface IServerlessCluster

    • getClusterReadEndpoint

      @Stability(Stable) @NotNull public Endpoint getClusterReadEndpoint()
      The endpoint to use for read/write operations.
      Specified by:
      getClusterReadEndpoint in interface IServerlessCluster

    • getConnections

      @Stability(Stable) @NotNull public Connections getConnections()
      Access to the network connections.
      Specified by:
      getConnections in interface IConnectable

    • getNewCfnProps

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

    • getSecurityGroups

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

    • getSecret

      @Stability(Stable) @Nullable public ISecret getSecret()
      The secret attached to this cluster.

    • getEnableDataApi

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

    • setEnableDataApi

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