software.amazon.awscdk.services.rds

Class ServerlessCluster.Builder

java.lang.Object

software.amazon.awscdk.services.rds.ServerlessCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServerlessCluster>

Enclosing class:

ServerlessCluster

@Stability(value=Experimental)
public static final class ServerlessCluster.Builder
extends Object
implements software.amazon.jsii.Builder<ServerlessCluster>

(experimental) A fluent builder for ServerlessCluster.

Method Summary

Modifier and Type	Method and Description
ServerlessCluster.Builder	backupRetention(Duration backupRetention) (experimental) The number of days during which automatic DB snapshots are retained.
ServerlessCluster	build()
ServerlessCluster.Builder	clusterIdentifier(String clusterIdentifier) (experimental) An optional identifier for the cluster.
static ServerlessCluster.Builder	create(software.constructs.Construct scope, String id)
ServerlessCluster.Builder	credentials(Credentials credentials) (experimental) Credentials for the administrative user.
ServerlessCluster.Builder	defaultDatabaseName(String defaultDatabaseName) (experimental) Name of a database which is automatically created inside the cluster.
ServerlessCluster.Builder	deletionProtection(Boolean deletionProtection) (experimental) Indicates whether the DB cluster should have deletion protection enabled.
ServerlessCluster.Builder	enableDataApi(Boolean enableDataApi) (experimental) Whether to enable the Data API.
ServerlessCluster.Builder	engine(IClusterEngine engine) (experimental) What kind of database to start.
ServerlessCluster.Builder	parameterGroup(IParameterGroup parameterGroup) (experimental) Additional parameters to pass to the database engine.
ServerlessCluster.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
ServerlessCluster.Builder	scaling(ServerlessScalingOptions scaling) (experimental) Scaling configuration of an Aurora Serverless database cluster.
ServerlessCluster.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) (experimental) Security group.
ServerlessCluster.Builder	storageEncryptionKey(IKey storageEncryptionKey) (experimental) The KMS key for storage encryption.
ServerlessCluster.Builder	subnetGroup(ISubnetGroup subnetGroup) (experimental) Existing subnet group for the cluster.
ServerlessCluster.Builder	vpc(IVpc vpc) (experimental) The VPC that this Aurora Serverless cluster has been created in.
ServerlessCluster.Builder	vpcSubnets(SubnetSelection vpcSubnets) (experimental) Where to place the instances within the VPC.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static ServerlessCluster.Builder create(software.constructs.Construct scope,
                                                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ServerlessCluster.Builder.

engine

@Stability(value=Experimental)
public ServerlessCluster.Builder engine(IClusterEngine engine)

(experimental) What kind of database to start.

Parameters:

engine - What kind of database to start. This parameter is required.

Returns:

this

vpc

@Stability(value=Experimental)
public ServerlessCluster.Builder vpc(IVpc vpc)

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

Parameters:

vpc - The VPC that this Aurora Serverless cluster has been created in. This parameter is required.

Returns:

this

backupRetention

@Stability(value=Experimental)
public ServerlessCluster.Builder backupRetention(Duration backupRetention)

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

Parameters:

backupRetention - The number of days during which automatic DB snapshots are retained. This parameter is required.

Returns:

this

clusterIdentifier

@Stability(value=Experimental)
public ServerlessCluster.Builder clusterIdentifier(String clusterIdentifier)

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

Parameters:

clusterIdentifier - An optional identifier for the cluster. This parameter is required.

Returns:

this

credentials

@Stability(value=Experimental)
public ServerlessCluster.Builder credentials(Credentials credentials)

(experimental) Credentials for the administrative user.

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

Parameters:

credentials - Credentials for the administrative user. This parameter is required.

Returns:

this

defaultDatabaseName

@Stability(value=Experimental)
public ServerlessCluster.Builder defaultDatabaseName(String defaultDatabaseName)

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

Default: - Database is not created in cluster.

Parameters:

defaultDatabaseName - Name of a database which is automatically created inside the cluster. This parameter is required.

Returns:

this

deletionProtection

@Stability(value=Experimental)
public ServerlessCluster.Builder deletionProtection(Boolean deletionProtection)

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

Default: - true if removalPolicy is RETAIN, false otherwise

Parameters:

deletionProtection - Indicates whether the DB cluster should have deletion protection enabled. This parameter is required.

Returns:

this

enableDataApi

@Stability(value=Experimental)
public ServerlessCluster.Builder enableDataApi(Boolean enableDataApi)

(experimental) Whether to enable the Data API.

Default: false

Parameters:

enableDataApi - Whether to enable the Data API. This parameter is required.

Returns:

this

See Also:

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

parameterGroup

@Stability(value=Experimental)
public ServerlessCluster.Builder parameterGroup(IParameterGroup parameterGroup)

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

Default: - no parameter group.

Parameters:

parameterGroup - Additional parameters to pass to the database engine. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Experimental)
public ServerlessCluster.Builder removalPolicy(RemovalPolicy removalPolicy)

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

Parameters:

removalPolicy - The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. This parameter is required.

Returns:

this

scaling

@Stability(value=Experimental)
public ServerlessCluster.Builder scaling(ServerlessScalingOptions scaling)

(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

Parameters:

scaling - Scaling configuration of an Aurora Serverless database cluster. This parameter is required.

Returns:

this

securityGroups

@Stability(value=Experimental)
public ServerlessCluster.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

(experimental) Security group.

Default: - a new security group is created.

Parameters:

securityGroups - Security group. This parameter is required.

Returns:

this

storageEncryptionKey

@Stability(value=Experimental)
public ServerlessCluster.Builder storageEncryptionKey(IKey storageEncryptionKey)

(experimental) The KMS key for storage encryption.

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

Parameters:

storageEncryptionKey - The KMS key for storage encryption. This parameter is required.

Returns:

this

subnetGroup

@Stability(value=Experimental)
public ServerlessCluster.Builder subnetGroup(ISubnetGroup subnetGroup)

(experimental) Existing subnet group for the cluster.

Default: - a new subnet group will be created.

Parameters:

subnetGroup - Existing subnet group for the cluster. This parameter is required.

Returns:

this

vpcSubnets

@Stability(value=Experimental)
public ServerlessCluster.Builder vpcSubnets(SubnetSelection vpcSubnets)

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

Default: - the VPC default strategy if not specified.

Parameters:

vpcSubnets - Where to place the instances within the VPC. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public ServerlessCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<ServerlessCluster>