Package software.amazon.awscdk.services.neptune.alpha

Class DatabaseClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.neptune.alpha.DatabaseClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseClusterProps>

Enclosing interface:

DatabaseClusterProps

@Stability(Experimental)
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	associatedRoles(List<? extends IRole> associatedRoles)	Sets the value of DatabaseClusterProps.getAssociatedRoles()
DatabaseClusterProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of DatabaseClusterProps.getAutoMinorVersionUpgrade()
DatabaseClusterProps.Builder	backupRetention(Duration backupRetention)	Sets the value of DatabaseClusterProps.getBackupRetention()
DatabaseClusterProps	build()	Builds the configured instance.
DatabaseClusterProps.Builder	cloudwatchLogsExports(List<? extends LogType> 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	clusterParameterGroup(IClusterParameterGroup clusterParameterGroup)	Sets the value of DatabaseClusterProps.getClusterParameterGroup()
DatabaseClusterProps.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)	Sets the value of DatabaseClusterProps.getCopyTagsToSnapshot()
DatabaseClusterProps.Builder	dbClusterName(String dbClusterName)	Sets the value of DatabaseClusterProps.getDbClusterName()
DatabaseClusterProps.Builder	deletionProtection(Boolean deletionProtection)	Sets the value of DatabaseClusterProps.getDeletionProtection()
DatabaseClusterProps.Builder	engineVersion(EngineVersion engineVersion)	Sets the value of DatabaseClusterProps.getEngineVersion()
DatabaseClusterProps.Builder	iamAuthentication(Boolean iamAuthentication)	Sets the value of DatabaseClusterProps.getIamAuthentication()
DatabaseClusterProps.Builder	instanceIdentifierBase(String instanceIdentifierBase)	Sets the value of DatabaseClusterProps.getInstanceIdentifierBase()
DatabaseClusterProps.Builder	instances(Number instances)	Sets the value of DatabaseClusterProps.getInstances()
DatabaseClusterProps.Builder	instanceType(InstanceType instanceType)	Sets the value of DatabaseClusterProps.getInstanceType()
DatabaseClusterProps.Builder	kmsKey(IKey kmsKey)	Sets the value of DatabaseClusterProps.getKmsKey()
DatabaseClusterProps.Builder	parameterGroup(IParameterGroup parameterGroup)	Sets the value of DatabaseClusterProps.getParameterGroup()
DatabaseClusterProps.Builder	port(Number port)	Sets the value of DatabaseClusterProps.getPort()
DatabaseClusterProps.Builder	preferredBackupWindow(String preferredBackupWindow)	Sets the value of DatabaseClusterProps.getPreferredBackupWindow()
DatabaseClusterProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()
DatabaseClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of DatabaseClusterProps.getRemovalPolicy()
DatabaseClusterProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of DatabaseClusterProps.getSecurityGroups()
DatabaseClusterProps.Builder	serverlessScalingConfiguration(ServerlessScalingConfiguration serverlessScalingConfiguration)	Sets the value of DatabaseClusterProps.getServerlessScalingConfiguration()
DatabaseClusterProps.Builder	storageEncrypted(Boolean storageEncrypted)	Sets the value of DatabaseClusterProps.getStorageEncrypted()
DatabaseClusterProps.Builder	subnetGroup(ISubnetGroup subnetGroup)	Sets the value of DatabaseClusterProps.getSubnetGroup()
DatabaseClusterProps.Builder	vpc(IVpc vpc)	Sets the value of DatabaseClusterProps.getVpc()
DatabaseClusterProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of DatabaseClusterProps.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

instanceType

@Stability(Experimental)
public DatabaseClusterProps.Builder instanceType(InstanceType instanceType)

Sets the value of DatabaseClusterProps.getInstanceType()

Parameters:

instanceType - What type of instance to start for the replicas. This parameter is required.

Returns:

this

vpc

@Stability(Experimental)
public DatabaseClusterProps.Builder vpc(IVpc vpc)

Sets the value of DatabaseClusterProps.getVpc()

Parameters:

vpc - What subnets to run the Neptune instances in. This parameter is required. Must be at least 2 subnets in two different AZs.

Returns:

this

associatedRoles

@Stability(Experimental)
public DatabaseClusterProps.Builder associatedRoles(List<? extends IRole> associatedRoles)

Sets the value of DatabaseClusterProps.getAssociatedRoles()

Parameters:

associatedRoles - A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.

Returns:

this

autoMinorVersionUpgrade

@Stability(Experimental)
public DatabaseClusterProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Sets the value of DatabaseClusterProps.getAutoMinorVersionUpgrade()

Parameters:

autoMinorVersionUpgrade - If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.

Returns:

this

backupRetention

@Stability(Experimental)
public DatabaseClusterProps.Builder backupRetention(Duration backupRetention)

Sets the value of DatabaseClusterProps.getBackupRetention()

Parameters:

backupRetention - How many days to retain the backup.

Returns:

this

cloudwatchLogsExports

@Stability(Experimental)
public DatabaseClusterProps.Builder cloudwatchLogsExports(List<? extends LogType> 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(Experimental)
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(Experimental)
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

clusterParameterGroup

@Stability(Experimental)
public DatabaseClusterProps.Builder clusterParameterGroup(IClusterParameterGroup clusterParameterGroup)

Sets the value of DatabaseClusterProps.getClusterParameterGroup()

Parameters:

clusterParameterGroup - Additional parameters to pass to the database engine.

Returns:

this

copyTagsToSnapshot

@Stability(Experimental)
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

dbClusterName

@Stability(Experimental)
public DatabaseClusterProps.Builder dbClusterName(String dbClusterName)

Sets the value of DatabaseClusterProps.getDbClusterName()

Parameters:

dbClusterName - An optional identifier for the cluster.

Returns:

this

deletionProtection

@Stability(Experimental)
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

engineVersion

@Stability(Experimental)
public DatabaseClusterProps.Builder engineVersion(EngineVersion engineVersion)

Sets the value of DatabaseClusterProps.getEngineVersion()

Parameters:

engineVersion - What version of the database to start.

Returns:

this

iamAuthentication

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

Sets the value of DatabaseClusterProps.getIamAuthentication()

Parameters:

iamAuthentication - Map AWS Identity and Access Management (IAM) accounts to database accounts.

Returns:

this

instanceIdentifierBase

@Stability(Experimental)
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(Experimental)
public DatabaseClusterProps.Builder instances(Number instances)

Sets the value of DatabaseClusterProps.getInstances()

Parameters:

instances - Number of Neptune compute instances.

Returns:

this

kmsKey

@Stability(Experimental)
public DatabaseClusterProps.Builder kmsKey(IKey kmsKey)

Sets the value of DatabaseClusterProps.getKmsKey()

Parameters:

kmsKey - The KMS key for storage encryption.

Returns:

this

parameterGroup

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

Sets the value of DatabaseClusterProps.getParameterGroup()

Parameters:

parameterGroup - The DB parameter group to associate with the instance.

Returns:

this

port

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

Sets the value of DatabaseClusterProps.getPort()

Parameters:

port - The port number on which the DB instances in the DB cluster accept connections.

Returns:

this

preferredBackupWindow

@Stability(Experimental)
public DatabaseClusterProps.Builder preferredBackupWindow(String preferredBackupWindow)

Sets the value of DatabaseClusterProps.getPreferredBackupWindow()

Parameters:

preferredBackupWindow - A daily time range in 24-hours UTC format in which backups preferably execute. Must be at least 30 minutes long.

Example: '01:00-02:00'

Returns:

this

preferredMaintenanceWindow

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

Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - A weekly time range in which maintenance should preferably execute. Must be at least 30 minutes long.

Example: 'tue:04:17-tue:04:47'

Returns:

this

removalPolicy

@Stability(Experimental)
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 or replaced during a stack update, or when the stack is deleted. This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.

Returns:

this

securityGroups

@Stability(Experimental)
public DatabaseClusterProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of DatabaseClusterProps.getSecurityGroups()

Parameters:

securityGroups - Security group.

Returns:

this

serverlessScalingConfiguration

@Stability(Experimental)
public DatabaseClusterProps.Builder serverlessScalingConfiguration(ServerlessScalingConfiguration serverlessScalingConfiguration)

Sets the value of DatabaseClusterProps.getServerlessScalingConfiguration()

Parameters:

serverlessScalingConfiguration - Specify minimum and maximum NCUs capacity for a serverless cluster. See https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html

Returns:

this

storageEncrypted

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

Sets the value of DatabaseClusterProps.getStorageEncrypted()

Parameters:

storageEncrypted - Whether to enable storage encryption.

Returns:

this

subnetGroup

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

Sets the value of DatabaseClusterProps.getSubnetGroup()

Parameters:

subnetGroup - Existing subnet group for the cluster.

Returns:

this

vpcSubnets

@Stability(Experimental)
public DatabaseClusterProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of DatabaseClusterProps.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the instances within the VPC.

Returns:

this

build

@Stability(Experimental)
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