Package software.amazon.awscdk.services.rds

Class ServerlessClusterFromSnapshotProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.ServerlessClusterFromSnapshotProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServerlessClusterFromSnapshotProps>

Enclosing interface:

ServerlessClusterFromSnapshotProps

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

A builder for ServerlessClusterFromSnapshotProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ServerlessClusterFromSnapshotProps.Builder	backupRetention(Duration backupRetention)	Sets the value of ServerlessClusterFromSnapshotProps.getBackupRetention()
ServerlessClusterFromSnapshotProps	build()	Builds the configured instance.
ServerlessClusterFromSnapshotProps.Builder	clusterIdentifier(String clusterIdentifier)	Sets the value of ServerlessClusterFromSnapshotProps.getClusterIdentifier()
ServerlessClusterFromSnapshotProps.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)	Sets the value of ServerlessClusterFromSnapshotProps.getCopyTagsToSnapshot()
ServerlessClusterFromSnapshotProps.Builder	credentials(SnapshotCredentials credentials)	Sets the value of ServerlessClusterFromSnapshotProps.getCredentials()
ServerlessClusterFromSnapshotProps.Builder	defaultDatabaseName(String defaultDatabaseName)	Sets the value of ServerlessClusterFromSnapshotProps.getDefaultDatabaseName()
ServerlessClusterFromSnapshotProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of ServerlessClusterFromSnapshotProps.getDeletionProtection()
ServerlessClusterFromSnapshotProps.Builder	enableDataApi(Boolean enableDataApi)	Sets the value of ServerlessClusterFromSnapshotProps.getEnableDataApi()
ServerlessClusterFromSnapshotProps.Builder	engine(IClusterEngine engine)	Sets the value of ServerlessClusterFromSnapshotProps.getEngine()
ServerlessClusterFromSnapshotProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of ServerlessClusterFromSnapshotProps.getParameterGroup()
ServerlessClusterFromSnapshotProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of ServerlessClusterFromSnapshotProps.getRemovalPolicy()
ServerlessClusterFromSnapshotProps.Builder	scaling(ServerlessScalingOptions scaling)	Sets the value of ServerlessClusterFromSnapshotProps.getScaling()
ServerlessClusterFromSnapshotProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ServerlessClusterFromSnapshotProps.getSecurityGroups()
ServerlessClusterFromSnapshotProps.Builder	snapshotIdentifier(String snapshotIdentifier)	Sets the value of ServerlessClusterFromSnapshotProps.getSnapshotIdentifier()
ServerlessClusterFromSnapshotProps.Builder	subnetGroup(ISubnetGroup subnetGroup)	Sets the value of ServerlessClusterFromSnapshotProps.getSubnetGroup()
ServerlessClusterFromSnapshotProps.Builder	vpc(IVpc vpc)	Sets the value of ServerlessClusterFromSnapshotProps.getVpc()
ServerlessClusterFromSnapshotProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of ServerlessClusterFromSnapshotProps.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 ServerlessClusterFromSnapshotProps.Builder engine(IClusterEngine engine)

Sets the value of ServerlessClusterFromSnapshotProps.getEngine()

Parameters:

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

Returns:

this

snapshotIdentifier

@Stability(Stable)
public ServerlessClusterFromSnapshotProps.Builder snapshotIdentifier(String snapshotIdentifier)

Sets the value of ServerlessClusterFromSnapshotProps.getSnapshotIdentifier()

Parameters:

snapshotIdentifier - The identifier for the DB instance snapshot or DB cluster snapshot to restore from. This parameter is required. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB instance snapshot.

Returns:

this

backupRetention

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

Sets the value of ServerlessClusterFromSnapshotProps.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 ServerlessClusterFromSnapshotProps.Builder clusterIdentifier(String clusterIdentifier)

Sets the value of ServerlessClusterFromSnapshotProps.getClusterIdentifier()

Parameters:

clusterIdentifier - An optional identifier for the cluster.

Returns:

this

copyTagsToSnapshot

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

Sets the value of ServerlessClusterFromSnapshotProps.getCopyTagsToSnapshot()

Parameters:

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

Returns:

this

credentials

@Stability(Stable)
public ServerlessClusterFromSnapshotProps.Builder credentials(SnapshotCredentials credentials)

Sets the value of ServerlessClusterFromSnapshotProps.getCredentials()

Parameters:

credentials - Master user credentials. Note - It is not possible to change the master username for a snapshot; however, it is possible to provide (or generate) a new password.

Returns:

this

defaultDatabaseName

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

Sets the value of ServerlessClusterFromSnapshotProps.getDefaultDatabaseName()

Parameters:

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

Returns:

this

deletionProtection

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

Sets the value of ServerlessClusterFromSnapshotProps.getDeletionProtection()

Parameters:

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

Returns:

this

enableDataApi

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

Sets the value of ServerlessClusterFromSnapshotProps.getEnableDataApi()

Parameters:

enableDataApi - Whether to enable the Data API.

Returns:

this

parameterGroup

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

Sets the value of ServerlessClusterFromSnapshotProps.getParameterGroup()

Parameters:

parameterGroup - Additional parameters to pass to the database engine.

Returns:

this

removalPolicy

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

Sets the value of ServerlessClusterFromSnapshotProps.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 ServerlessClusterFromSnapshotProps.Builder scaling(ServerlessScalingOptions scaling)

Sets the value of ServerlessClusterFromSnapshotProps.getScaling()

Parameters:

scaling - Scaling configuration of an Aurora Serverless database cluster.

Returns:

this

securityGroups

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

Sets the value of ServerlessClusterFromSnapshotProps.getSecurityGroups()

Parameters:

securityGroups - Security group.

Returns:

this

subnetGroup

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

Sets the value of ServerlessClusterFromSnapshotProps.getSubnetGroup()

Parameters:

subnetGroup - Existing subnet group for the cluster.

Returns:

this

vpc

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

Sets the value of ServerlessClusterFromSnapshotProps.getVpc()

Parameters:

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

Returns:

this

vpcSubnets

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

Sets the value of ServerlessClusterFromSnapshotProps.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 ServerlessClusterFromSnapshotProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ServerlessClusterFromSnapshotProps

Throws:

NullPointerException - if any required attribute was not provided