software.amazon.awscdk.services.rds

Interface ServerlessClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServerlessClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:54.698Z")
 @Stability(value=Experimental)
public interface ServerlessClusterProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a new 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	Interface and Description
static class	ServerlessClusterProps.Builder A builder for ServerlessClusterProps
static class	ServerlessClusterProps.Jsii$Proxy An implementation for ServerlessClusterProps

Method Summary

Modifier and Type	Method and Description
static ServerlessClusterProps.Builder	builder()
default Duration	getBackupRetention() (experimental) The number of days during which automatic DB snapshots are retained.
default String	getClusterIdentifier() (experimental) An optional identifier for the cluster.
default Credentials	getCredentials() (experimental) Credentials for the administrative user.
default String	getDefaultDatabaseName() (experimental) Name of a database which is automatically created inside the cluster.
default Boolean	getDeletionProtection() (experimental) Indicates whether the DB cluster should have deletion protection enabled.
default Boolean	getEnableDataApi() (experimental) Whether to enable the Data API.
IClusterEngine	getEngine() (experimental) What kind of database to start.
default IParameterGroup	getParameterGroup() (experimental) Additional parameters to pass to the database engine.
default RemovalPolicy	getRemovalPolicy() (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
default ServerlessScalingOptions	getScaling() (experimental) Scaling configuration of an Aurora Serverless database cluster.
default List<ISecurityGroup>	getSecurityGroups() (experimental) Security group.
default IKey	getStorageEncryptionKey() (experimental) The KMS key for storage encryption.
default ISubnetGroup	getSubnetGroup() (experimental) Existing subnet group for the cluster.
default IVpc	getVpc() (experimental) The VPC that this Aurora Serverless cluster has been created in.
default SubnetSelection	getVpcSubnets() (experimental) Where to place the instances within the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEngine

@Stability(value=Experimental)
 @NotNull
IClusterEngine getEngine()

(experimental) What kind of database to start.

getBackupRetention

@Stability(value=Experimental)
 @Nullable
default Duration getBackupRetention()

(experimental) The number of days during which automatic DB snapshots are retained.

Automatic backup retention cannot be disabled on serverless clusters. Must be a value from 1 day to 35 days.

Default: Duration.days(1)

getClusterIdentifier

@Stability(value=Experimental)
 @Nullable
default String getClusterIdentifier()

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

getCredentials

@Stability(value=Experimental)
 @Nullable
default Credentials getCredentials()

(experimental) Credentials for the administrative user.

Default: - A username of 'admin' and SecretsManager-generated password

getDefaultDatabaseName

@Stability(value=Experimental)
 @Nullable
default String getDefaultDatabaseName()

(experimental) Name of a database which is automatically created inside the cluster.

Default: - Database is not created in cluster.

getDeletionProtection

@Stability(value=Experimental)
 @Nullable
default Boolean getDeletionProtection()

(experimental) Indicates whether the DB cluster should have deletion protection enabled.

Default: - true if removalPolicy is RETAIN, false otherwise

getEnableDataApi

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableDataApi()

(experimental) Whether to enable the Data API.

Default: false

See Also:

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

getParameterGroup

@Stability(value=Experimental)
 @Nullable
default IParameterGroup getParameterGroup()

(experimental) Additional parameters to pass to the database engine.

Default: - no parameter group.

getRemovalPolicy

@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)

getScaling

@Stability(value=Experimental)
 @Nullable
default ServerlessScalingOptions getScaling()

(experimental) Scaling configuration of an Aurora Serverless database cluster.

Default: - Serverless cluster is automatically paused after 5 minutes of being idle. minimum capacity: 2 ACU maximum capacity: 16 ACU

getSecurityGroups

@Stability(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

(experimental) Security group.

Default: - a new security group is created if `vpc` was provided. If the `vpc` property was not provided, no VPC security groups will be associated with the DB cluster.

getStorageEncryptionKey

@Stability(value=Experimental)
 @Nullable
default IKey getStorageEncryptionKey()

(experimental) The KMS key for storage encryption.

Default: - the default master key will be used for storage encryption

getSubnetGroup

@Stability(value=Experimental)
 @Nullable
default ISubnetGroup getSubnetGroup()

(experimental) Existing subnet group for the cluster.

Default: - a new subnet group is created if `vpc` was provided. If the `vpc` property was not provided, no subnet group will be associated with the DB cluster

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

(experimental) The VPC that this Aurora Serverless cluster has been created in.

Default: - the default VPC in the account and region will be used

getVpcSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) Where to place the instances within the VPC.

If provided, the vpc property must also be specified.

Default: - the VPC default strategy if not specified.

builder

@Stability(value=Experimental)
static ServerlessClusterProps.Builder builder()

Returns:

a ServerlessClusterProps.Builder of ServerlessClusterProps