Package software.amazon.awscdk.services.docdb

Class CfnDBClusterProps.Builder

java.lang.Object
software.amazon.awscdk.services.docdb.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

    • availabilityZones

      @Stability(Stable) public CfnDBClusterProps.Builder availabilityZones(List<String> availabilityZones)
      Sets the value of CfnDBClusterProps.getAvailabilityZones()
      Parameters:
      availabilityZones - A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
      Returns:
      this

    • backupRetentionPeriod

      @Stability(Stable) public CfnDBClusterProps.Builder backupRetentionPeriod(Number backupRetentionPeriod)
      Sets the value of CfnDBClusterProps.getBackupRetentionPeriod()
      Parameters:
      backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1

      Constraints:

      • Must be a value from 1 to 35.
      Returns:
      this

    • copyTagsToSnapshot

      @Stability(Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
      Sets the value of CfnDBClusterProps.getCopyTagsToSnapshot()
      Parameters:
      copyTagsToSnapshot - the value to be set.
      Returns:
      this

    • copyTagsToSnapshot

      @Stability(Stable) public CfnDBClusterProps.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
      Sets the value of CfnDBClusterProps.getCopyTagsToSnapshot()
      Parameters:
      copyTagsToSnapshot - the value to be set.
      Returns:
      this

    • dbClusterIdentifier

      @Stability(Stable) public CfnDBClusterProps.Builder dbClusterIdentifier(String dbClusterIdentifier)
      Sets the value of CfnDBClusterProps.getDbClusterIdentifier()
      Parameters:
      dbClusterIdentifier - The cluster identifier. This parameter is stored as a lowercase string. Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.
      • The first character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster

      Returns:
      this

    • dbClusterParameterGroupName

      @Stability(Stable) public CfnDBClusterProps.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
      Sets the value of CfnDBClusterProps.getDbClusterParameterGroupName()
      Parameters:
      dbClusterParameterGroupName - The name of the cluster parameter group to associate with this cluster.
      Returns:
      this

    • dbSubnetGroupName

      @Stability(Stable) public CfnDBClusterProps.Builder dbSubnetGroupName(String dbSubnetGroupName)
      Sets the value of CfnDBClusterProps.getDbSubnetGroupName()
      Parameters:
      dbSubnetGroupName - A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.

      Example: mySubnetgroup

      Returns:
      this

    • deletionProtection

      @Stability(Stable) public CfnDBClusterProps.Builder deletionProtection(Boolean deletionProtection)
      Sets the value of CfnDBClusterProps.getDeletionProtection()
      Parameters:
      deletionProtection - Protects clusters from being accidentally deleted. If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
      Returns:
      this

    • deletionProtection

      @Stability(Stable) public CfnDBClusterProps.Builder deletionProtection(IResolvable deletionProtection)
      Sets the value of CfnDBClusterProps.getDeletionProtection()
      Parameters:
      deletionProtection - Protects clusters from being accidentally deleted. If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
      Returns:
      this

    • enableCloudwatchLogsExports

      @Stability(Stable) public CfnDBClusterProps.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)
      Sets the value of CfnDBClusterProps.getEnableCloudwatchLogsExports()
      Parameters:
      enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .
      Returns:
      this

    • engineVersion

      @Stability(Stable) public CfnDBClusterProps.Builder engineVersion(String engineVersion)
      Sets the value of CfnDBClusterProps.getEngineVersion()
      Parameters:
      engineVersion - The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnDBClusterProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnDBClusterProps.getKmsKeyId()
      Parameters:
      kmsKeyId - The AWS KMS key identifier for an encrypted cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

      If an encryption key is not specified in KmsKeyId :

      • If the StorageEncrypted parameter is true , Amazon DocumentDB uses your default encryption key.

      AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .

      Returns:
      this

    • masterUsername

      @Stability(Stable) public CfnDBClusterProps.Builder masterUsername(String masterUsername)
      Sets the value of CfnDBClusterProps.getMasterUsername()
      Parameters:
      masterUsername - The name of the master user for the cluster. Constraints:

      • Must be from 1 to 63 letters or numbers.
      • The first character must be a letter.
      • Cannot be a reserved word for the chosen database engine.
      Returns:
      this

    • masterUserPassword

      @Stability(Stable) public CfnDBClusterProps.Builder masterUserPassword(String masterUserPassword)
      Sets the value of CfnDBClusterProps.getMasterUserPassword()
      Parameters:
      masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

      Constraints: Must contain from 8 to 100 characters.

      Returns:
      this

    • port

      @Stability(Stable) public CfnDBClusterProps.Builder port(Number port)
      Sets the value of CfnDBClusterProps.getPort()
      Parameters:
      port - Specifies the port that the database engine is listening on.
      Returns:
      this

    • preferredBackupWindow

      @Stability(Stable) public CfnDBClusterProps.Builder preferredBackupWindow(String preferredBackupWindow)
      Sets the value of CfnDBClusterProps.getPreferredBackupWindow()
      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .

      Constraints:

      • Must be in the format hh24:mi-hh24:mi .
      • Must be in Universal Coordinated Time (UTC).
      • Must not conflict with the preferred maintenance window.
      • Must be at least 30 minutes.
      Returns:
      this

    • preferredMaintenanceWindow

      @Stability(Stable) public CfnDBClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
      Sets the value of CfnDBClusterProps.getPreferredMaintenanceWindow()
      Parameters:
      preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

      Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

      Constraints: Minimum 30-minute window.

      Returns:
      this

    • restoreToTime

      @Stability(Stable) public CfnDBClusterProps.Builder restoreToTime(String restoreToTime)
      Sets the value of CfnDBClusterProps.getRestoreToTime()
      Parameters:
      restoreToTime - The date and time to restore the cluster to. Valid values: A time in Universal Coordinated Time (UTC) format.

      Constraints:

      • Must be before the latest restorable time for the instance.
      • Must be specified if the UseLatestRestorableTime parameter is not provided.
      • Cannot be specified if the UseLatestRestorableTime parameter is true .
      • Cannot be specified if the RestoreType parameter is copy-on-write .

      Example: 2015-03-07T23:45:00Z

      Returns:
      this

    • restoreType

      @Stability(Stable) public CfnDBClusterProps.Builder restoreType(String restoreType)
      Sets the value of CfnDBClusterProps.getRestoreType()
      Parameters:
      restoreType - The type of restore to be performed. You can specify one of the following values:.
      • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
      • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

      Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

      If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

      Returns:
      this

    • snapshotIdentifier

      @Stability(Stable) public CfnDBClusterProps.Builder snapshotIdentifier(String snapshotIdentifier)
      Sets the value of CfnDBClusterProps.getSnapshotIdentifier()
      Parameters:
      snapshotIdentifier - The identifier for the snapshot or cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

      Constraints:

      • Must match the identifier of an existing snapshot.
      Returns:
      this

    • sourceDbClusterIdentifier

      @Stability(Stable) public CfnDBClusterProps.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)
      Sets the value of CfnDBClusterProps.getSourceDbClusterIdentifier()
      Parameters:
      sourceDbClusterIdentifier - The identifier of the source cluster from which to restore. Constraints:

      • Must match the identifier of an existing DBCluster .
      Returns:
      this

    • storageEncrypted

      @Stability(Stable) public CfnDBClusterProps.Builder storageEncrypted(Boolean storageEncrypted)
      Sets the value of CfnDBClusterProps.getStorageEncrypted()
      Parameters:
      storageEncrypted - Specifies whether the cluster is encrypted.
      Returns:
      this

    • storageEncrypted

      @Stability(Stable) public CfnDBClusterProps.Builder storageEncrypted(IResolvable storageEncrypted)
      Sets the value of CfnDBClusterProps.getStorageEncrypted()
      Parameters:
      storageEncrypted - Specifies whether the cluster is encrypted.
      Returns:
      this

    • storageType

      @Stability(Stable) public CfnDBClusterProps.Builder storageType(String storageType)
      Sets the value of CfnDBClusterProps.getStorageType()
      Parameters:
      storageType - The storage type to associate with the DB cluster. For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .

      Valid values for storage type - standard | iopt1

      Default value is standard

      When you create a DocumentDB DB cluster with the storage type set to iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to standard .

      Returns:
      this

    • tags

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

    • useLatestRestorableTime

      @Stability(Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)
      Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()
      Parameters:
      useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. Default: false

      Constraints: Cannot be specified if the RestoreToTime parameter is provided.

      Returns:
      this

    • useLatestRestorableTime

      @Stability(Stable) public CfnDBClusterProps.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime)
      Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()
      Parameters:
      useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. Default: false

      Constraints: Cannot be specified if the RestoreToTime parameter is provided.

      Returns:
      this

    • vpcSecurityGroupIds

      @Stability(Stable) public CfnDBClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)
      Sets the value of CfnDBClusterProps.getVpcSecurityGroupIds()
      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this cluster.
      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