software.amazon.awscdk.services.neptune

Class CfnDBCluster.Builder

java.lang.Object

software.amazon.awscdk.services.neptune.CfnDBCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBCluster>

Enclosing class:

CfnDBCluster

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

A fluent builder for CfnDBCluster.

Method Summary

Modifier and Type	Method and Description
CfnDBCluster.Builder	associatedRoles(IResolvable associatedRoles) Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
CfnDBCluster.Builder	associatedRoles(List<? extends Object> associatedRoles) Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
CfnDBCluster.Builder	availabilityZones(List<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
CfnDBCluster.Builder	backupRetentionPeriod(Number backupRetentionPeriod) Specifies the number of days for which automatic DB snapshots are retained.
CfnDBCluster	build()
static CfnDBCluster.Builder	create(software.constructs.Construct scope, String id)
CfnDBCluster.Builder	dbClusterIdentifier(String dbClusterIdentifier) Contains a user-supplied DB cluster identifier.
CfnDBCluster.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName) Provides the name of the DB cluster parameter group.
CfnDBCluster.Builder	dbSubnetGroupName(String dbSubnetGroupName) Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
CfnDBCluster.Builder	deletionProtection(Boolean deletionProtection) Indicates whether or not the DB cluster has deletion protection enabled.
CfnDBCluster.Builder	deletionProtection(IResolvable deletionProtection) Indicates whether or not the DB cluster has deletion protection enabled.
CfnDBCluster.Builder	enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports) Specifies a list of log types that are enabled for export to CloudWatch Logs.
CfnDBCluster.Builder	engineVersion(String engineVersion) Indicates the database engine version.
CfnDBCluster.Builder	iamAuthEnabled(Boolean iamAuthEnabled) True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
CfnDBCluster.Builder	iamAuthEnabled(IResolvable iamAuthEnabled) True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
CfnDBCluster.Builder	kmsKeyId(String kmsKeyId) If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
CfnDBCluster.Builder	port(Number port) Specifies the port that the database engine is listening on.
CfnDBCluster.Builder	preferredBackupWindow(String preferredBackupWindow) Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` .
CfnDBCluster.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
CfnDBCluster.Builder	restoreToTime(String restoreToTime) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
CfnDBCluster.Builder	restoreType(String restoreType) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
CfnDBCluster.Builder	snapshotIdentifier(String snapshotIdentifier) Specifies the identifier for a DB cluster snapshot.
CfnDBCluster.Builder	sourceDbClusterIdentifier(String sourceDbClusterIdentifier) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
CfnDBCluster.Builder	storageEncrypted(Boolean storageEncrypted) Indicates whether the DB cluster is encrypted.
CfnDBCluster.Builder	storageEncrypted(IResolvable storageEncrypted) Indicates whether the DB cluster is encrypted.
CfnDBCluster.Builder	tags(List<? extends CfnTag> tags) The tags assigned to this cluster.
CfnDBCluster.Builder	useLatestRestorableTime(Boolean useLatestRestorableTime) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
CfnDBCluster.Builder	useLatestRestorableTime(IResolvable useLatestRestorableTime) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
CfnDBCluster.Builder	vpcSecurityGroupIds(List<String> vpcSecurityGroupIds) Provides a list of VPC security groups that the DB cluster belongs to.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnDBCluster.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDBCluster.DBClusterRoleProperty.Builder.

associatedRoles

@Stability(value=Stable)
public CfnDBCluster.Builder associatedRoles(IResolvable 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.

Parameters:

associatedRoles - Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. This parameter is required.

Returns:

this

associatedRoles

@Stability(value=Stable)
public CfnDBCluster.Builder associatedRoles(List<? extends Object> 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.

Parameters:

associatedRoles - Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. This parameter is required.

Returns:

this

availabilityZones

@Stability(value=Stable)
public CfnDBCluster.Builder availabilityZones(List<String> availabilityZones)

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

Parameters:

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

Returns:

this

backupRetentionPeriod

@Stability(value=Stable)
public CfnDBCluster.Builder backupRetentionPeriod(Number 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.

Parameters:

backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained. This parameter is required.

Returns:

this

dbClusterIdentifier

@Stability(value=Stable)
public CfnDBCluster.Builder dbClusterIdentifier(String dbClusterIdentifier)

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

Parameters:

dbClusterIdentifier - Contains a user-supplied DB cluster identifier. This parameter is required.

Returns:

this

dbClusterParameterGroupName

@Stability(value=Stable)
public CfnDBCluster.Builder dbClusterParameterGroupName(String 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.

Parameters:

dbClusterParameterGroupName - Provides the name of the DB cluster parameter group. This parameter is required.

Returns:

this

dbSubnetGroupName

@Stability(value=Stable)
public CfnDBCluster.Builder dbSubnetGroupName(String dbSubnetGroupName)

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

Parameters:

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

Returns:

this

deletionProtection

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

Indicates whether or not the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled.

Parameters:

deletionProtection - Indicates whether or not the DB cluster has deletion protection enabled. This parameter is required.

Returns:

this

deletionProtection

@Stability(value=Stable)
public CfnDBCluster.Builder deletionProtection(IResolvable deletionProtection)

Indicates whether or not the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled.

Parameters:

deletionProtection - Indicates whether or not the DB cluster has deletion protection enabled. This parameter is required.

Returns:

this

enableCloudwatchLogsExports

@Stability(value=Stable)
public CfnDBCluster.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)

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

Parameters:

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

Returns:

this

engineVersion

@Stability(value=Stable)
public CfnDBCluster.Builder engineVersion(String engineVersion)

Indicates the database engine version.

Parameters:

engineVersion - Indicates the database engine version. This parameter is required.

Returns:

this

iamAuthEnabled

@Stability(value=Stable)
public CfnDBCluster.Builder iamAuthEnabled(Boolean iamAuthEnabled)

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

Parameters:

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

Returns:

this

iamAuthEnabled

@Stability(value=Stable)
public CfnDBCluster.Builder iamAuthEnabled(IResolvable iamAuthEnabled)

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

Parameters:

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

Returns:

this

kmsKeyId

@Stability(value=Stable)
public CfnDBCluster.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

this

port

@Stability(value=Stable)
public CfnDBCluster.Builder port(Number port)

Specifies the port that the database engine is listening on.

Parameters:

port - Specifies the port that the database engine is listening on. This parameter is required.

Returns:

this

preferredBackupWindow

@Stability(value=Stable)
public CfnDBCluster.Builder preferredBackupWindow(String 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.

Parameters:

preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` . This parameter is required.

Returns:

this

preferredMaintenanceWindow

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

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

Parameters:

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

Returns:

this

restoreToTime

@Stability(value=Stable)
public CfnDBCluster.Builder restoreToTime(String 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.

Parameters:

restoreToTime - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This parameter is required.

Returns:

this

restoreType

@Stability(value=Stable)
public CfnDBCluster.Builder restoreType(String 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.

Parameters:

restoreType - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This parameter is required.

Returns:

this

snapshotIdentifier

@Stability(value=Stable)
public CfnDBCluster.Builder snapshotIdentifier(String 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.

Parameters:

snapshotIdentifier - Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. This parameter is required.

Returns:

this

sourceDbClusterIdentifier

@Stability(value=Stable)
public CfnDBCluster.Builder sourceDbClusterIdentifier(String 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.

Parameters:

sourceDbClusterIdentifier - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This parameter is required.

Returns:

this

storageEncrypted

@Stability(value=Stable)
public CfnDBCluster.Builder storageEncrypted(Boolean 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.

Parameters:

storageEncrypted - Indicates whether the DB cluster is encrypted. This parameter is required.

Returns:

this

storageEncrypted

@Stability(value=Stable)
public CfnDBCluster.Builder storageEncrypted(IResolvable 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.

Parameters:

storageEncrypted - Indicates whether the DB cluster is encrypted. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnDBCluster.Builder tags(List<? extends CfnTag> tags)

The tags assigned to this cluster.

Parameters:

tags - The tags assigned to this cluster. This parameter is required.

Returns:

this

useLatestRestorableTime

@Stability(value=Stable)
public CfnDBCluster.Builder useLatestRestorableTime(Boolean 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.

Parameters:

useLatestRestorableTime - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This parameter is required.

Returns:

this

useLatestRestorableTime

@Stability(value=Stable)
public CfnDBCluster.Builder useLatestRestorableTime(IResolvable 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.

Parameters:

useLatestRestorableTime - Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This parameter is required.

Returns:

this

vpcSecurityGroupIds

@Stability(value=Stable)
public CfnDBCluster.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)

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

Parameters:

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

Returns:

this

build

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

Specified by:

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