software.amazon.awscdk.services.neptune

Class CfnDBClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.neptune.CfnDBClusterProps.Builder

Enclosing interface:

CfnDBClusterProps

public static final class CfnDBClusterProps.Builder
extends java.lang.Object

A builder for CfnDBClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDBClusterProps.Builder	associatedRoles(IResolvable associatedRoles) Sets the value of CfnDBClusterProps.getAssociatedRoles()
CfnDBClusterProps.Builder	associatedRoles(java.util.List<? extends java.lang.Object> associatedRoles) Sets the value of CfnDBClusterProps.getAssociatedRoles()
CfnDBClusterProps.Builder	availabilityZones(java.util.List<java.lang.String> availabilityZones) Sets the value of CfnDBClusterProps.getAvailabilityZones()
CfnDBClusterProps.Builder	backupRetentionPeriod(java.lang.Number backupRetentionPeriod) Sets the value of CfnDBClusterProps.getBackupRetentionPeriod()
CfnDBClusterProps	build() Builds the configured instance.
CfnDBClusterProps.Builder	dbClusterIdentifier(java.lang.String dbClusterIdentifier) Sets the value of CfnDBClusterProps.getDbClusterIdentifier()
CfnDBClusterProps.Builder	dbClusterParameterGroupName(java.lang.String dbClusterParameterGroupName) Sets the value of CfnDBClusterProps.getDbClusterParameterGroupName()
CfnDBClusterProps.Builder	dbSubnetGroupName(java.lang.String dbSubnetGroupName) Sets the value of CfnDBClusterProps.getDbSubnetGroupName()
CfnDBClusterProps.Builder	deletionProtection(java.lang.Boolean deletionProtection) Sets the value of CfnDBClusterProps.getDeletionProtection()
CfnDBClusterProps.Builder	deletionProtection(IResolvable deletionProtection) Sets the value of CfnDBClusterProps.getDeletionProtection()
CfnDBClusterProps.Builder	enableCloudwatchLogsExports(java.util.List<java.lang.String> enableCloudwatchLogsExports) Sets the value of CfnDBClusterProps.getEnableCloudwatchLogsExports()
CfnDBClusterProps.Builder	engineVersion(java.lang.String engineVersion) Sets the value of CfnDBClusterProps.getEngineVersion()
CfnDBClusterProps.Builder	iamAuthEnabled(java.lang.Boolean iamAuthEnabled) Sets the value of CfnDBClusterProps.getIamAuthEnabled()
CfnDBClusterProps.Builder	iamAuthEnabled(IResolvable iamAuthEnabled) Sets the value of CfnDBClusterProps.getIamAuthEnabled()
CfnDBClusterProps.Builder	kmsKeyId(java.lang.String kmsKeyId) Sets the value of CfnDBClusterProps.getKmsKeyId()
CfnDBClusterProps.Builder	port(java.lang.Number port) Sets the value of CfnDBClusterProps.getPort()
CfnDBClusterProps.Builder	preferredBackupWindow(java.lang.String preferredBackupWindow) Sets the value of CfnDBClusterProps.getPreferredBackupWindow()
CfnDBClusterProps.Builder	preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow) Sets the value of CfnDBClusterProps.getPreferredMaintenanceWindow()
CfnDBClusterProps.Builder	restoreToTime(java.lang.String restoreToTime) Sets the value of CfnDBClusterProps.getRestoreToTime()
CfnDBClusterProps.Builder	restoreType(java.lang.String restoreType) Sets the value of CfnDBClusterProps.getRestoreType()
CfnDBClusterProps.Builder	snapshotIdentifier(java.lang.String snapshotIdentifier) Sets the value of CfnDBClusterProps.getSnapshotIdentifier()
CfnDBClusterProps.Builder	sourceDbClusterIdentifier(java.lang.String sourceDbClusterIdentifier) Sets the value of CfnDBClusterProps.getSourceDbClusterIdentifier()
CfnDBClusterProps.Builder	storageEncrypted(java.lang.Boolean storageEncrypted) Sets the value of CfnDBClusterProps.getStorageEncrypted()
CfnDBClusterProps.Builder	storageEncrypted(IResolvable storageEncrypted) Sets the value of CfnDBClusterProps.getStorageEncrypted()
CfnDBClusterProps.Builder	tags(java.util.List<? extends CfnTag> tags) Sets the value of CfnDBClusterProps.getTags()
CfnDBClusterProps.Builder	useLatestRestorableTime(java.lang.Boolean useLatestRestorableTime) Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()
CfnDBClusterProps.Builder	useLatestRestorableTime(IResolvable useLatestRestorableTime) Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()
CfnDBClusterProps.Builder	vpcSecurityGroupIds(java.util.List<java.lang.String> vpcSecurityGroupIds) Sets the value of CfnDBClusterProps.getVpcSecurityGroupIds()

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

associatedRoles

public CfnDBClusterProps.Builder associatedRoles(IResolvable associatedRoles)

Sets the value of CfnDBClusterProps.getAssociatedRoles()

Parameters:

associatedRoles - Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

Returns:

this

associatedRoles

public CfnDBClusterProps.Builder associatedRoles(java.util.List<? extends java.lang.Object> associatedRoles)

Sets the value of CfnDBClusterProps.getAssociatedRoles()

Parameters:

associatedRoles - Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

Returns:

this

availabilityZones

public CfnDBClusterProps.Builder availabilityZones(java.util.List<java.lang.String> availabilityZones)

Sets the value of CfnDBClusterProps.getAvailabilityZones()

Parameters:

availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Returns:

this

backupRetentionPeriod

public CfnDBClusterProps.Builder backupRetentionPeriod(java.lang.Number backupRetentionPeriod)

Sets the value of CfnDBClusterProps.getBackupRetentionPeriod()

Parameters:

backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained. An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Returns:

this

dbClusterIdentifier

public CfnDBClusterProps.Builder dbClusterIdentifier(java.lang.String dbClusterIdentifier)

Sets the value of CfnDBClusterProps.getDbClusterIdentifier()

Parameters:

dbClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

Returns:

this

dbClusterParameterGroupName

public CfnDBClusterProps.Builder dbClusterParameterGroupName(java.lang.String dbClusterParameterGroupName)

Sets the value of CfnDBClusterProps.getDbClusterParameterGroupName()

Parameters:

dbClusterParameterGroupName - Provides the name of the DB cluster parameter group. An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Returns:

this

dbSubnetGroupName

public CfnDBClusterProps.Builder dbSubnetGroupName(java.lang.String dbSubnetGroupName)

Sets the value of CfnDBClusterProps.getDbSubnetGroupName()

Parameters:

dbSubnetGroupName - Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Returns:

this

deletionProtection

public CfnDBClusterProps.Builder deletionProtection(java.lang.Boolean deletionProtection)

Sets the value of CfnDBClusterProps.getDeletionProtection()

Parameters:

deletionProtection - Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Returns:

this

deletionProtection

public CfnDBClusterProps.Builder deletionProtection(IResolvable deletionProtection)

Sets the value of CfnDBClusterProps.getDeletionProtection()

Parameters:

deletionProtection - Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Returns:

this

enableCloudwatchLogsExports

public CfnDBClusterProps.Builder enableCloudwatchLogsExports(java.util.List<java.lang.String> enableCloudwatchLogsExports)

Sets the value of CfnDBClusterProps.getEnableCloudwatchLogsExports()

Parameters:

enableCloudwatchLogsExports - Specifies a list of log types that are enabled for export to CloudWatch Logs.

Returns:

this

engineVersion

public CfnDBClusterProps.Builder engineVersion(java.lang.String engineVersion)

Sets the value of CfnDBClusterProps.getEngineVersion()

Parameters:

engineVersion - Indicates the database engine version.

Returns:

this

iamAuthEnabled

public CfnDBClusterProps.Builder iamAuthEnabled(java.lang.Boolean iamAuthEnabled)

Sets the value of CfnDBClusterProps.getIamAuthEnabled()

Parameters:

iamAuthEnabled - True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

this

iamAuthEnabled

public CfnDBClusterProps.Builder iamAuthEnabled(IResolvable iamAuthEnabled)

Sets the value of CfnDBClusterProps.getIamAuthEnabled()

Parameters:

iamAuthEnabled - True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

this

kmsKeyId

public CfnDBClusterProps.Builder kmsKeyId(java.lang.String kmsKeyId)

Sets the value of CfnDBClusterProps.getKmsKeyId()

Parameters:

kmsKeyId - If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.

Returns:

this

port

public CfnDBClusterProps.Builder port(java.lang.Number port)

Sets the value of CfnDBClusterProps.getPort()

Parameters:

port - Specifies the port that the database engine is listening on.

Returns:

this

preferredBackupWindow

public CfnDBClusterProps.Builder preferredBackupWindow(java.lang.String preferredBackupWindow)

Sets the value of CfnDBClusterProps.getPreferredBackupWindow()

Parameters:

preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` . An update may require some interruption.

Returns:

this

preferredMaintenanceWindow

public CfnDBClusterProps.Builder preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)

Sets the value of CfnDBClusterProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

this

restoreToTime

public CfnDBClusterProps.Builder restoreToTime(java.lang.String restoreToTime)

Sets the value of CfnDBClusterProps.getRestoreToTime()

Parameters:

restoreToTime - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

this

restoreType

public CfnDBClusterProps.Builder restoreType(java.lang.String restoreType)

Sets the value of CfnDBClusterProps.getRestoreType()

Parameters:

restoreType - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

this

snapshotIdentifier

public CfnDBClusterProps.Builder snapshotIdentifier(java.lang.String snapshotIdentifier)

Sets the value of CfnDBClusterProps.getSnapshotIdentifier()

Parameters:

snapshotIdentifier - Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

Returns:

this

sourceDbClusterIdentifier

public CfnDBClusterProps.Builder sourceDbClusterIdentifier(java.lang.String sourceDbClusterIdentifier)

Sets the value of CfnDBClusterProps.getSourceDbClusterIdentifier()

Parameters:

sourceDbClusterIdentifier - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

this

storageEncrypted

public CfnDBClusterProps.Builder storageEncrypted(java.lang.Boolean storageEncrypted)

Sets the value of CfnDBClusterProps.getStorageEncrypted()

Parameters:

storageEncrypted - Indicates whether the DB cluster is encrypted. If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.

Returns:

this

storageEncrypted

public CfnDBClusterProps.Builder storageEncrypted(IResolvable storageEncrypted)

Sets the value of CfnDBClusterProps.getStorageEncrypted()

Parameters:

storageEncrypted - Indicates whether the DB cluster is encrypted. If you specify the DBClusterIdentifier , DBSnapshotIdentifier , or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.

If you specify the KmsKeyId , you must enable encryption by setting StorageEncrypted to true.

Returns:

this

tags

public CfnDBClusterProps.Builder tags(java.util.List<? extends CfnTag> tags)

Sets the value of CfnDBClusterProps.getTags()

Parameters:

tags - The tags assigned to this cluster.

Returns:

this

useLatestRestorableTime

public CfnDBClusterProps.Builder useLatestRestorableTime(java.lang.Boolean useLatestRestorableTime)

Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()

Parameters:

useLatestRestorableTime - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

this

useLatestRestorableTime

public CfnDBClusterProps.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime)

Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()

Parameters:

useLatestRestorableTime - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

this

vpcSecurityGroupIds

public CfnDBClusterProps.Builder vpcSecurityGroupIds(java.util.List<java.lang.String> vpcSecurityGroupIds)

Sets the value of CfnDBClusterProps.getVpcSecurityGroupIds()

Parameters:

vpcSecurityGroupIds - Provides a list of VPC security groups that the DB cluster belongs to.

Returns:

this

build

public CfnDBClusterProps build()

Builds the configured instance.

Returns:

a new instance of CfnDBClusterProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided