software.amazon.awscdk.services.rds

Class DatabaseClusterFromSnapshotProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.DatabaseClusterFromSnapshotProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseClusterFromSnapshotProps>

Enclosing interface:

DatabaseClusterFromSnapshotProps

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

A builder for DatabaseClusterFromSnapshotProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

engine

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder engine(IClusterEngine engine)

Sets the value of DatabaseClusterFromSnapshotProps.getEngine()

Parameters:

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

Returns:

this

instanceProps

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder instanceProps(InstanceProps instanceProps)

Sets the value of DatabaseClusterFromSnapshotProps.getInstanceProps()

Parameters:

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

Returns:

this

snapshotIdentifier

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder snapshotIdentifier(String snapshotIdentifier)

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

backtrackWindow

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder backtrackWindow(Duration backtrackWindow)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder backup(BackupProps backup)

Sets the value of DatabaseClusterFromSnapshotProps.getBackup()

Parameters:

backup - Backup settings.

Returns:

this

cloudwatchLogsExports

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder cloudwatchLogsExports(List<String> cloudwatchLogsExports)

Sets the value of DatabaseClusterFromSnapshotProps.getCloudwatchLogsExports()

Parameters:

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

Returns:

this

cloudwatchLogsRetention

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder cloudwatchLogsRetention(RetentionDays cloudwatchLogsRetention)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder cloudwatchLogsRetentionRole(IRole cloudwatchLogsRetentionRole)

Sets the value of DatabaseClusterFromSnapshotProps.getCloudwatchLogsRetentionRole()

Parameters:

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

Returns:

this

clusterIdentifier

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder clusterIdentifier(String clusterIdentifier)

Sets the value of DatabaseClusterFromSnapshotProps.getClusterIdentifier()

Parameters:

clusterIdentifier - An optional identifier for the cluster.

Returns:

this

copyTagsToSnapshot

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

Sets the value of DatabaseClusterFromSnapshotProps.getCopyTagsToSnapshot()

Parameters:

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

Returns:

this

credentials

@Stability(value=Deprecated)
 @Deprecated
public DatabaseClusterFromSnapshotProps.Builder credentials(Credentials credentials)

Deprecated. use `snapshotCredentials` which allows to generate a new password

Sets the value of DatabaseClusterFromSnapshotProps.getCredentials()

Parameters:

credentials - Credentials for the administrative user. Note - using this prop only works with Credentials.fromPassword() with the username of the snapshot, Credentials.fromUsername() with the username and password of the snapshot or Credentials.fromSecret() with a secret containing the username and password of the snapshot.

Returns:

this

defaultDatabaseName

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder defaultDatabaseName(String defaultDatabaseName)

Sets the value of DatabaseClusterFromSnapshotProps.getDefaultDatabaseName()

Parameters:

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

Returns:

this

deletionProtection

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder deletionProtection(Boolean deletionProtection)

Sets the value of DatabaseClusterFromSnapshotProps.getDeletionProtection()

Parameters:

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

Returns:

this

iamAuthentication

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder iamAuthentication(Boolean iamAuthentication)

Sets the value of DatabaseClusterFromSnapshotProps.getIamAuthentication()

Parameters:

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

Returns:

this

instanceIdentifierBase

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder instanceIdentifierBase(String instanceIdentifierBase)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder instances(Number instances)

Sets the value of DatabaseClusterFromSnapshotProps.getInstances()

Parameters:

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

Returns:

this

instanceUpdateBehaviour

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder instanceUpdateBehaviour(InstanceUpdateBehaviour instanceUpdateBehaviour)

Sets the value of DatabaseClusterFromSnapshotProps.getInstanceUpdateBehaviour()

Parameters:

instanceUpdateBehaviour - The ordering of updates for instances.

Returns:

this

monitoringInterval

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder monitoringInterval(Duration monitoringInterval)

Sets the value of DatabaseClusterFromSnapshotProps.getMonitoringInterval()

Parameters:

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

Returns:

this

monitoringRole

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder monitoringRole(IRole monitoringRole)

Sets the value of DatabaseClusterFromSnapshotProps.getMonitoringRole()

Parameters:

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

Returns:

this

parameterGroup

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder parameterGroup(IParameterGroup parameterGroup)

Sets the value of DatabaseClusterFromSnapshotProps.getParameterGroup()

Parameters:

parameterGroup - Additional parameters to pass to the database engine.

Returns:

this

parameters

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder parameters(Map<String,String> parameters)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder port(Number port)

Sets the value of DatabaseClusterFromSnapshotProps.getPort()

Parameters:

port - What port to listen on.

Returns:

this

preferredMaintenanceWindow

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder s3ExportBuckets(List<? extends IBucket> s3ExportBuckets)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder s3ExportRole(IRole s3ExportRole)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder s3ImportBuckets(List<? extends IBucket> s3ImportBuckets)

Sets the value of DatabaseClusterFromSnapshotProps.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(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder s3ImportRole(IRole s3ImportRole)

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

snapshotCredentials

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder snapshotCredentials(SnapshotCredentials snapshotCredentials)

Sets the value of DatabaseClusterFromSnapshotProps.getSnapshotCredentials()

Parameters:

snapshotCredentials - 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

storageEncrypted

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder storageEncrypted(Boolean storageEncrypted)

Sets the value of DatabaseClusterFromSnapshotProps.getStorageEncrypted()

Parameters:

storageEncrypted - Whether to enable storage encryption.

Returns:

this

storageEncryptionKey

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder storageEncryptionKey(IKey storageEncryptionKey)

Sets the value of DatabaseClusterFromSnapshotProps.getStorageEncryptionKey()

Parameters:

storageEncryptionKey - The KMS key for storage encryption. If specified, {@link storageEncrypted} will be set to true.

Returns:

this

subnetGroup

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps.Builder subnetGroup(ISubnetGroup subnetGroup)

Sets the value of DatabaseClusterFromSnapshotProps.getSubnetGroup()

Parameters:

subnetGroup - Existing subnet group for the cluster.

Returns:

this

build

@Stability(value=Stable)
public DatabaseClusterFromSnapshotProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DatabaseClusterFromSnapshotProps

Throws:

NullPointerException - if any required attribute was not provided