Package software.amazon.awscdk.services.neptune

Class CfnDBClusterProps.Builder

java.lang.Object
software.amazon.awscdk.services.neptune.CfnDBClusterProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBClusterProps>
Enclosing interface:
CfnDBClusterProps
@Stability(Stable) public static final class CfnDBClusterProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDBClusterProps>
A builder for CfnDBClusterProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • associatedRoles

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

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

      @Stability(Stable) public CfnDBClusterProps.Builder availabilityZones(List<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

      @Stability(Stable) public CfnDBClusterProps.Builder backupRetentionPeriod(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

    • copyTagsToSnapshot

      @Stability(Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
      Sets the value of CfnDBClusterProps.getCopyTagsToSnapshot()
      Parameters:
      copyTagsToSnapshot - If set to true , tags are copied to any snapshot of the DB cluster that is created..
      Returns:
      this

    • copyTagsToSnapshot

      @Stability(Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
      Sets the value of CfnDBClusterProps.getCopyTagsToSnapshot()
      Parameters:
      copyTagsToSnapshot - If set to true , tags are copied to any snapshot of the DB cluster that is created..
      Returns:
      this

    • dbClusterIdentifier

      @Stability(Stable) public CfnDBClusterProps.Builder dbClusterIdentifier(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

      @Stability(Stable) public CfnDBClusterProps.Builder dbClusterParameterGroupName(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

    • dbInstanceParameterGroupName

      @Stability(Stable) public CfnDBClusterProps.Builder dbInstanceParameterGroupName(String dbInstanceParameterGroupName)
      Sets the value of CfnDBClusterProps.getDbInstanceParameterGroupName()
      Parameters:
      dbInstanceParameterGroupName - The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major engine version upgrade request

      Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

      Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

      • The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.
      Returns:
      this

    • dbSubnetGroupName

      @Stability(Stable) public CfnDBClusterProps.Builder dbSubnetGroupName(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

      @Stability(Stable) public CfnDBClusterProps.Builder deletionProtection(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

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

      @Stability(Stable) public CfnDBClusterProps.Builder enableCloudwatchLogsExports(List<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

      @Stability(Stable) public CfnDBClusterProps.Builder engineVersion(String engineVersion)
      Sets the value of CfnDBClusterProps.getEngineVersion()
      Parameters:
      engineVersion - Indicates the database engine version.
      Returns:
      this

    • iamAuthEnabled

      @Stability(Stable) public CfnDBClusterProps.Builder iamAuthEnabled(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

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

      @Stability(Stable) public CfnDBClusterProps.Builder kmsKeyId(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

      @Stability(Stable) public CfnDBClusterProps.Builder port(Number port)
      Sets the value of CfnDBClusterProps.getPort()
      Parameters:
      port - AWS::Neptune::DBCluster.Port.
      Returns:
      this

    • preferredBackupWindow

      @Stability(Stable) public CfnDBClusterProps.Builder preferredBackupWindow(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

      @Stability(Stable) public CfnDBClusterProps.Builder preferredMaintenanceWindow(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

      @Stability(Stable) public CfnDBClusterProps.Builder restoreToTime(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

      @Stability(Stable) public CfnDBClusterProps.Builder restoreType(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

    • serverlessScalingConfiguration

      @Stability(Stable) public CfnDBClusterProps.Builder serverlessScalingConfiguration(IResolvable serverlessScalingConfiguration)
      Sets the value of CfnDBClusterProps.getServerlessScalingConfiguration()
      Parameters:
      serverlessScalingConfiguration - AWS::Neptune::DBCluster.ServerlessScalingConfiguration.
      Returns:
      this

    • serverlessScalingConfiguration

      @Stability(Stable) public CfnDBClusterProps.Builder serverlessScalingConfiguration(CfnDBCluster.ServerlessScalingConfigurationProperty serverlessScalingConfiguration)
      Sets the value of CfnDBClusterProps.getServerlessScalingConfiguration()
      Parameters:
      serverlessScalingConfiguration - AWS::Neptune::DBCluster.ServerlessScalingConfiguration.
      Returns:
      this

    • snapshotIdentifier

      @Stability(Stable) public CfnDBClusterProps.Builder snapshotIdentifier(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

      @Stability(Stable) public CfnDBClusterProps.Builder sourceDbClusterIdentifier(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

      @Stability(Stable) public CfnDBClusterProps.Builder storageEncrypted(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

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

      @Stability(Stable) public CfnDBClusterProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDBClusterProps.getTags()
      Parameters:
      tags - The tags assigned to this cluster.
      Returns:
      this

    • useLatestRestorableTime

      @Stability(Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(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

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

      @Stability(Stable) public CfnDBClusterProps.Builder vpcSecurityGroupIds(List<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

      @Stability(Stable) public CfnDBClusterProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBClusterProps>
      Returns:
      a new instance of CfnDBClusterProps
      Throws:
      NullPointerException - if any required attribute was not provided