Package software.amazon.awscdk.services.rds

Class DatabaseClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.DatabaseClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseClusterProps>

Enclosing interface:

DatabaseClusterProps

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

A builder for DatabaseClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DatabaseClusterProps.Builder	backtrackWindow(Duration backtrackWindow)	Sets the value of DatabaseClusterProps.getBacktrackWindow()
DatabaseClusterProps.Builder	backup(BackupProps backup)	Sets the value of DatabaseClusterProps.getBackup()
DatabaseClusterProps	build()	Builds the configured instance.
DatabaseClusterProps.Builder	cloudwatchLogsExports(List<String> cloudwatchLogsExports)	Sets the value of DatabaseClusterProps.getCloudwatchLogsExports()
DatabaseClusterProps.Builder	cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)	Sets the value of DatabaseClusterProps.getCloudwatchLogsRetention()
DatabaseClusterProps.Builder	cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)	Sets the value of DatabaseClusterProps.getCloudwatchLogsRetentionRole()
DatabaseClusterProps.Builder	clusterIdentifier(String clusterIdentifier)	Sets the value of DatabaseClusterProps.getClusterIdentifier()
DatabaseClusterProps.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)	Sets the value of DatabaseClusterProps.getCopyTagsToSnapshot()
DatabaseClusterProps.Builder	credentials(Credentials credentials)	Sets the value of DatabaseClusterProps.getCredentials()
DatabaseClusterProps.Builder	defaultDatabaseName(String defaultDatabaseName)	Sets the value of DatabaseClusterProps.getDefaultDatabaseName()
DatabaseClusterProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of DatabaseClusterProps.getDeletionProtection()
DatabaseClusterProps.Builder	engine(IClusterEngine engine)	Sets the value of DatabaseClusterProps.getEngine()
DatabaseClusterProps.Builder	iamAuthentication(Boolean iamAuthentication)	Sets the value of DatabaseClusterProps.getIamAuthentication()
DatabaseClusterProps.Builder	instanceIdentifierBase(String instanceIdentifierBase)	Sets the value of DatabaseClusterProps.getInstanceIdentifierBase()
DatabaseClusterProps.Builder	instanceProps(InstanceProps instanceProps)	Sets the value of DatabaseClusterProps.getInstanceProps()
DatabaseClusterProps.Builder	instances(Number instances)	Sets the value of DatabaseClusterProps.getInstances()
DatabaseClusterProps.Builder	monitoringInterval(Duration monitoringInterval)	Sets the value of DatabaseClusterProps.getMonitoringInterval()
DatabaseClusterProps.Builder	monitoringRole(IRole monitoringRole)	Sets the value of DatabaseClusterProps.getMonitoringRole()
DatabaseClusterProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of DatabaseClusterProps.getParameterGroup()
DatabaseClusterProps.Builder	parameters(Map<String,String> parameters)	Sets the value of DatabaseClusterProps.getParameters()
DatabaseClusterProps.Builder	port(Number port)	Sets the value of DatabaseClusterProps.getPort()
DatabaseClusterProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()
DatabaseClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of DatabaseClusterProps.getRemovalPolicy()
DatabaseClusterProps.Builder	s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)	Sets the value of DatabaseClusterProps.getS3ExportBuckets()
DatabaseClusterProps.Builder	s3ExportRole(IRole s3ExportRole)	Sets the value of DatabaseClusterProps.getS3ExportRole()
DatabaseClusterProps.Builder	s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)	Sets the value of DatabaseClusterProps.getS3ImportBuckets()
DatabaseClusterProps.Builder	s3ImportRole(IRole s3ImportRole)	Sets the value of DatabaseClusterProps.getS3ImportRole()
DatabaseClusterProps.Builder	storageEncrypted(Boolean storageEncrypted)	Sets the value of DatabaseClusterProps.getStorageEncrypted()
DatabaseClusterProps.Builder	storageEncryptionKey(IKey storageEncryptionKey)	Sets the value of DatabaseClusterProps.getStorageEncryptionKey()
DatabaseClusterProps.Builder	subnetGroup(ISubnetGroup subnetGroup)	Sets the value of DatabaseClusterProps.getSubnetGroup()

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 DatabaseClusterProps.Builder engine(IClusterEngine engine)

Sets the value of DatabaseClusterProps.getEngine()

Parameters:

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

Returns:

this

instanceProps

@Stability(Stable)
public DatabaseClusterProps.Builder instanceProps(InstanceProps instanceProps)

Sets the value of DatabaseClusterProps.getInstanceProps()

Parameters:

instanceProps - Settings for the individual instances that are launched. This parameter is required.

Returns:

this

backtrackWindow

@Stability(Stable)
public DatabaseClusterProps.Builder backtrackWindow(Duration backtrackWindow)

Sets the value of DatabaseClusterProps.getBacktrackWindow()

Parameters:

backtrackWindow - The number of seconds to set a cluster's target backtrack window to. This feature is only supported by the Aurora MySQL database engine and cannot be enabled on existing clusters.

Returns:

this

backup

@Stability(Stable)
public DatabaseClusterProps.Builder backup(BackupProps backup)

Sets the value of DatabaseClusterProps.getBackup()

Parameters:

backup - Backup settings.

Returns:

this

cloudwatchLogsExports

@Stability(Stable)
public DatabaseClusterProps.Builder cloudwatchLogsExports(List<String> cloudwatchLogsExports)

Sets the value of DatabaseClusterProps.getCloudwatchLogsExports()

Parameters:

cloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs.

Returns:

this

cloudwatchLogsRetention

@Stability(Stable)
public DatabaseClusterProps.Builder cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)

Sets the value of DatabaseClusterProps.getCloudwatchLogsRetention()

Parameters:

cloudwatchLogsRetention - The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

Returns:

this

cloudwatchLogsRetentionRole

@Stability(Stable)
public DatabaseClusterProps.Builder cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)

Sets the value of DatabaseClusterProps.getCloudwatchLogsRetentionRole()

Parameters:

cloudwatchLogsRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Returns:

this

clusterIdentifier

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

Sets the value of DatabaseClusterProps.getClusterIdentifier()

Parameters:

clusterIdentifier - An optional identifier for the cluster.

Returns:

this

copyTagsToSnapshot

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

Sets the value of DatabaseClusterProps.getCopyTagsToSnapshot()

Parameters:

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

Returns:

this

credentials

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

Sets the value of DatabaseClusterProps.getCredentials()

Parameters:

credentials - Credentials for the administrative user.

Returns:

this

defaultDatabaseName

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

Sets the value of DatabaseClusterProps.getDefaultDatabaseName()

Parameters:

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

Returns:

this

deletionProtection

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

Sets the value of DatabaseClusterProps.getDeletionProtection()

Parameters:

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

Returns:

this

iamAuthentication

@Stability(Stable)
public DatabaseClusterProps.Builder iamAuthentication(Boolean iamAuthentication)

Sets the value of DatabaseClusterProps.getIamAuthentication()

Parameters:

iamAuthentication - Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

Returns:

this

instanceIdentifierBase

@Stability(Stable)
public DatabaseClusterProps.Builder instanceIdentifierBase(String instanceIdentifierBase)

Sets the value of DatabaseClusterProps.getInstanceIdentifierBase()

Parameters:

instanceIdentifierBase - Base identifier for instances. Every replica is named by appending the replica number to this string, 1-based.

Returns:

this

instances

@Stability(Stable)
public DatabaseClusterProps.Builder instances(Number instances)

Sets the value of DatabaseClusterProps.getInstances()

Parameters:

instances - How many replicas/instances to create. Has to be at least 1.

Returns:

this

monitoringInterval

@Stability(Stable)
public DatabaseClusterProps.Builder monitoringInterval(Duration monitoringInterval)

Sets the value of DatabaseClusterProps.getMonitoringInterval()

Parameters:

monitoringInterval - The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances.

Returns:

this

monitoringRole

@Stability(Stable)
public DatabaseClusterProps.Builder monitoringRole(IRole monitoringRole)

Sets the value of DatabaseClusterProps.getMonitoringRole()

Parameters:

monitoringRole - Role that will be used to manage DB instances monitoring.

Returns:

this

parameterGroup

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

Sets the value of DatabaseClusterProps.getParameterGroup()

Parameters:

parameterGroup - Additional parameters to pass to the database engine.

Returns:

this

parameters

@Stability(Stable)
public DatabaseClusterProps.Builder parameters(Map<String,String> parameters)

Sets the value of DatabaseClusterProps.getParameters()

Parameters:

parameters - The parameters in the DBClusterParameterGroup to create automatically. You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBClusterParameterGroup.

Returns:

this

port

@Stability(Stable)
public DatabaseClusterProps.Builder port(Number port)

Sets the value of DatabaseClusterProps.getPort()

Parameters:

port - What port to listen on.

Returns:

this

preferredMaintenanceWindow

@Stability(Stable)
public DatabaseClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: 'Sun:23:45-Mon:00:15'

Returns:

this

removalPolicy

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

Sets the value of DatabaseClusterProps.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

s3ExportBuckets

@Stability(Stable)
public DatabaseClusterProps.Builder s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)

Sets the value of DatabaseClusterProps.getS3ExportBuckets()

Parameters:

s3ExportBuckets - S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. This property must not be used if s3ExportRole is used.

For MySQL:

Returns:

this

s3ExportRole

@Stability(Stable)
public DatabaseClusterProps.Builder s3ExportRole(IRole s3ExportRole)

Sets the value of DatabaseClusterProps.getS3ExportRole()

Parameters:

s3ExportRole - Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine.

This property must not be used if s3ExportBuckets is used.

For MySQL:

Returns:

this

s3ImportBuckets

@Stability(Stable)
public DatabaseClusterProps.Builder s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)

Sets the value of DatabaseClusterProps.getS3ImportBuckets()

Parameters:

s3ImportBuckets - S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. This property must not be used if s3ImportRole is used.

For MySQL:

Returns:

this

s3ImportRole

@Stability(Stable)
public DatabaseClusterProps.Builder s3ImportRole(IRole s3ImportRole)

Sets the value of DatabaseClusterProps.getS3ImportRole()

Parameters:

s3ImportRole - Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine.

This property must not be used if s3ImportBuckets is used.

For MySQL:

Returns:

this

storageEncrypted

@Stability(Stable)
public DatabaseClusterProps.Builder storageEncrypted(Boolean storageEncrypted)

Sets the value of DatabaseClusterProps.getStorageEncrypted()

Parameters:

storageEncrypted - Whether to enable storage encryption.

Returns:

this

storageEncryptionKey

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

Sets the value of DatabaseClusterProps.getStorageEncryptionKey()

Parameters:

storageEncryptionKey - The KMS key for storage encryption. If specified, storageEncrypted will be set to `true`.

Returns:

this

subnetGroup

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

Sets the value of DatabaseClusterProps.getSubnetGroup()

Parameters:

subnetGroup - Existing subnet group for the cluster.

Returns:

this

build

@Stability(Stable)
public DatabaseClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DatabaseClusterProps

Throws:

NullPointerException - if any required attribute was not provided