Package software.amazon.awscdk.services.rds

Class ServerlessClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.ServerlessClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServerlessClusterProps>

Enclosing interface:

ServerlessClusterProps

@Stability(Stable)
public static final class ServerlessClusterProps.Builder
extends Object
implements software.amazon.jsii.Builder<ServerlessClusterProps>

A builder for ServerlessClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ServerlessClusterProps.Builder	backupRetention(Duration backupRetention)	Sets the value of ServerlessClusterProps.getBackupRetention()
ServerlessClusterProps	build()	Builds the configured instance.
ServerlessClusterProps.Builder	clusterIdentifier(String clusterIdentifier)	Sets the value of ServerlessClusterProps.getClusterIdentifier()
ServerlessClusterProps.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)	Sets the value of ServerlessClusterProps.getCopyTagsToSnapshot()
ServerlessClusterProps.Builder	credentials(Credentials credentials)	Sets the value of ServerlessClusterProps.getCredentials()
ServerlessClusterProps.Builder	defaultDatabaseName(String defaultDatabaseName)	Sets the value of ServerlessClusterProps.getDefaultDatabaseName()
ServerlessClusterProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of ServerlessClusterProps.getDeletionProtection()
ServerlessClusterProps.Builder	enableDataApi(Boolean enableDataApi)	Sets the value of ServerlessClusterProps.getEnableDataApi()
ServerlessClusterProps.Builder	engine(IClusterEngine engine)	Sets the value of ServerlessClusterProps.getEngine()
ServerlessClusterProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of ServerlessClusterProps.getParameterGroup()
ServerlessClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of ServerlessClusterProps.getRemovalPolicy()
ServerlessClusterProps.Builder	scaling(ServerlessScalingOptions scaling)	Sets the value of ServerlessClusterProps.getScaling()
ServerlessClusterProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ServerlessClusterProps.getSecurityGroups()
ServerlessClusterProps.Builder	storageEncryptionKey(IKey storageEncryptionKey)	Sets the value of ServerlessClusterProps.getStorageEncryptionKey()
ServerlessClusterProps.Builder	subnetGroup(ISubnetGroup subnetGroup)	Sets the value of ServerlessClusterProps.getSubnetGroup()
ServerlessClusterProps.Builder	vpc(IVpc vpc)	Sets the value of ServerlessClusterProps.getVpc()
ServerlessClusterProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of ServerlessClusterProps.getVpcSubnets()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

engine

@Stability(Stable)
public ServerlessClusterProps.Builder engine(IClusterEngine engine)

Sets the value of ServerlessClusterProps.getEngine()

Parameters:

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

Returns:

this

backupRetention

@Stability(Stable)
public ServerlessClusterProps.Builder backupRetention(Duration backupRetention)

Sets the value of ServerlessClusterProps.getBackupRetention()

Parameters:

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

Returns:

this

clusterIdentifier

@Stability(Stable)
public ServerlessClusterProps.Builder clusterIdentifier(String clusterIdentifier)

Sets the value of ServerlessClusterProps.getClusterIdentifier()

Parameters:

clusterIdentifier - An optional identifier for the cluster.

Returns:

this

copyTagsToSnapshot

@Stability(Stable)
public ServerlessClusterProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

Sets the value of ServerlessClusterProps.getCopyTagsToSnapshot()

Parameters:

copyTagsToSnapshot - Whether to copy tags to the snapshot when a snapshot is created.

Returns:

this

credentials

@Stability(Stable)
public ServerlessClusterProps.Builder credentials(Credentials credentials)

Sets the value of ServerlessClusterProps.getCredentials()

Parameters:

credentials - Credentials for the administrative user.

Returns:

this

defaultDatabaseName

@Stability(Stable)
public ServerlessClusterProps.Builder defaultDatabaseName(String defaultDatabaseName)

Sets the value of ServerlessClusterProps.getDefaultDatabaseName()

Parameters:

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

Returns:

this

deletionProtection

@Stability(Stable)
public ServerlessClusterProps.Builder deletionProtection(Boolean deletionProtection)

Sets the value of ServerlessClusterProps.getDeletionProtection()

Parameters:

deletionProtection - Indicates whether the DB cluster should have deletion protection enabled.

Returns:

this

enableDataApi

@Stability(Stable)
public ServerlessClusterProps.Builder enableDataApi(Boolean enableDataApi)

Sets the value of ServerlessClusterProps.getEnableDataApi()

Parameters:

enableDataApi - Whether to enable the Data API.

Returns:

this

parameterGroup

@Stability(Stable)
public ServerlessClusterProps.Builder parameterGroup(IParameterGroup parameterGroup)

Sets the value of ServerlessClusterProps.getParameterGroup()

Parameters:

parameterGroup - Additional parameters to pass to the database engine.

Returns:

this

removalPolicy

@Stability(Stable)
public ServerlessClusterProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of ServerlessClusterProps.getRemovalPolicy()

Parameters:

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

Returns:

this

scaling

@Stability(Stable)
public ServerlessClusterProps.Builder scaling(ServerlessScalingOptions scaling)

Sets the value of ServerlessClusterProps.getScaling()

Parameters:

scaling - Scaling configuration of an Aurora Serverless database cluster.

Returns:

this

securityGroups

@Stability(Stable)
public ServerlessClusterProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ServerlessClusterProps.getSecurityGroups()

Parameters:

securityGroups - Security group.

Returns:

this

storageEncryptionKey

@Stability(Stable)
public ServerlessClusterProps.Builder storageEncryptionKey(IKey storageEncryptionKey)

Sets the value of ServerlessClusterProps.getStorageEncryptionKey()

Parameters:

storageEncryptionKey - The KMS key for storage encryption.

Returns:

this

subnetGroup

@Stability(Stable)
public ServerlessClusterProps.Builder subnetGroup(ISubnetGroup subnetGroup)

Sets the value of ServerlessClusterProps.getSubnetGroup()

Parameters:

subnetGroup - Existing subnet group for the cluster.

Returns:

this

vpc

@Stability(Stable)
public ServerlessClusterProps.Builder vpc(IVpc vpc)

Sets the value of ServerlessClusterProps.getVpc()

Parameters:

vpc - The VPC that this Aurora Serverless v1 Cluster has been created in.

Returns:

this

vpcSubnets

@Stability(Stable)
public ServerlessClusterProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of ServerlessClusterProps.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the instances within the VPC. If provided, the vpc property must also be specified.

Returns:

this

build

@Stability(Stable)
public ServerlessClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ServerlessClusterProps

Throws:

NullPointerException - if any required attribute was not provided