Package software.amazon.awscdk.cfnpropertymixins.services.docdb

Class CfnDBClusterMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • availabilityZones

      @Stability(Stable) public CfnDBClusterMixinProps.Builder availabilityZones(List<String> availabilityZones)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder backupRetentionPeriod(Number backupRetentionPeriod)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
      Sets the value of CfnDBClusterMixinProps.getCopyTagsToSnapshot()
      Parameters:
      copyTagsToSnapshot - Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false . The default is false .
      Returns:
      this

    • copyTagsToSnapshot

      @Stability(Stable) public CfnDBClusterMixinProps.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
      Sets the value of CfnDBClusterMixinProps.getCopyTagsToSnapshot()
      Parameters:
      copyTagsToSnapshot - Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false . The default is false .
      Returns:
      this

    • dbClusterIdentifier

      @Stability(Stable) public CfnDBClusterMixinProps.Builder dbClusterIdentifier(String dbClusterIdentifier)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
      Sets the value of CfnDBClusterMixinProps.getDbClusterParameterGroupName()
      Parameters:
      dbClusterParameterGroupName - The name of the cluster parameter group to associate with this cluster.
      Returns:
      this

    • dbSubnetGroupName

      @Stability(Stable) public CfnDBClusterMixinProps.Builder dbSubnetGroupName(String dbSubnetGroupName)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder deletionProtection(Boolean deletionProtection)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder deletionProtection(IResolvable deletionProtection)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder engineVersion(String engineVersion)
      Sets the value of CfnDBClusterMixinProps.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.

      If you intend to trigger an in-place upgrade, please refer to Amazon DocumentDB in-place major version upgrade . Note that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN template.

      Returns:
      this

    • globalClusterIdentifier

      @Stability(Stable) public CfnDBClusterMixinProps.Builder globalClusterIdentifier(String globalClusterIdentifier)
      Sets the value of CfnDBClusterMixinProps.getGlobalClusterIdentifier()
      Parameters:
      globalClusterIdentifier - The cluster identifier of the new global cluster.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnDBClusterMixinProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnDBClusterMixinProps.getKmsKeyId()
      Parameters:
      kmsKeyId - The AWS key identifier for an encrypted cluster. The AWS key identifier is the Amazon Resource Name (ARN) for the AWS encryption key. If you are creating a cluster using the same AWS account that owns the AWS encryption key that is used to encrypt the new cluster, you can use the AWS key alias instead of the ARN for the AWS 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 creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .

      Returns:
      this

    • manageMasterUserPassword

      @Stability(Stable) public CfnDBClusterMixinProps.Builder manageMasterUserPassword(Boolean manageMasterUserPassword)
      Sets the value of CfnDBClusterMixinProps.getManageMasterUserPassword()
      Parameters:
      manageMasterUserPassword - Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
      Returns:
      this

    • manageMasterUserPassword

      @Stability(Stable) public CfnDBClusterMixinProps.Builder manageMasterUserPassword(IResolvable manageMasterUserPassword)
      Sets the value of CfnDBClusterMixinProps.getManageMasterUserPassword()
      Parameters:
      manageMasterUserPassword - Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
      Returns:
      this

    • masterUsername

      @Stability(Stable) public CfnDBClusterMixinProps.Builder masterUsername(String masterUsername)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder masterUserPassword(String masterUserPassword)
      Sets the value of CfnDBClusterMixinProps.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

    • masterUserSecretKmsKeyId

      @Stability(Stable) public CfnDBClusterMixinProps.Builder masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
      Sets the value of CfnDBClusterMixinProps.getMasterUserSecretKmsKeyId()
      Parameters:
      masterUserSecretKmsKeyId - The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

      There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Returns:
      this

    • networkType

      @Stability(Stable) public CfnDBClusterMixinProps.Builder networkType(String networkType)
      Sets the value of CfnDBClusterMixinProps.getNetworkType()
      Parameters:
      networkType - The network type of the cluster. The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL ).

      For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

      Valid Values: IPV4 | DUAL

      Returns:
      this

    • port

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

    • preferredBackupWindow

      @Stability(Stable) public CfnDBClusterMixinProps.Builder preferredBackupWindow(String preferredBackupWindow)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder restoreToTime(String restoreToTime)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder restoreType(String restoreType)
      Sets the value of CfnDBClusterMixinProps.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

    • rotateMasterUserPassword

      @Stability(Stable) public CfnDBClusterMixinProps.Builder rotateMasterUserPassword(Boolean rotateMasterUserPassword)
      Sets the value of CfnDBClusterMixinProps.getRotateMasterUserPassword()
      Parameters:
      rotateMasterUserPassword - Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

      Constraint: You must apply the change immediately when rotating the master user password.

      Returns:
      this

    • rotateMasterUserPassword

      @Stability(Stable) public CfnDBClusterMixinProps.Builder rotateMasterUserPassword(IResolvable rotateMasterUserPassword)
      Sets the value of CfnDBClusterMixinProps.getRotateMasterUserPassword()
      Parameters:
      rotateMasterUserPassword - Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

      Constraint: You must apply the change immediately when rotating the master user password.

      Returns:
      this

    • serverlessV2ScalingConfiguration

      @Stability(Stable) public CfnDBClusterMixinProps.Builder serverlessV2ScalingConfiguration(IResolvable serverlessV2ScalingConfiguration)
      Sets the value of CfnDBClusterMixinProps.getServerlessV2ScalingConfiguration()
      Parameters:
      serverlessV2ScalingConfiguration - Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
      Returns:
      this

    • serverlessV2ScalingConfiguration

      @Stability(Stable) public CfnDBClusterMixinProps.Builder serverlessV2ScalingConfiguration(CfnDBClusterPropsMixin.ServerlessV2ScalingConfigurationProperty serverlessV2ScalingConfiguration)
      Sets the value of CfnDBClusterMixinProps.getServerlessV2ScalingConfiguration()
      Parameters:
      serverlessV2ScalingConfiguration - Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
      Returns:
      this

    • snapshotIdentifier

      @Stability(Stable) public CfnDBClusterMixinProps.Builder snapshotIdentifier(String snapshotIdentifier)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)
      Sets the value of CfnDBClusterMixinProps.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 CfnDBClusterMixinProps.Builder storageEncrypted(Boolean storageEncrypted)
      Sets the value of CfnDBClusterMixinProps.getStorageEncrypted()
      Parameters:
      storageEncrypted - Specifies whether the cluster is encrypted. If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.
      Returns:
      this

    • storageEncrypted

      @Stability(Stable) public CfnDBClusterMixinProps.Builder storageEncrypted(IResolvable storageEncrypted)
      Sets the value of CfnDBClusterMixinProps.getStorageEncrypted()
      Parameters:
      storageEncrypted - Specifies whether the cluster is encrypted. If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.
      Returns:
      this

    • storageType

      @Stability(Stable) public CfnDBClusterMixinProps.Builder storageType(String storageType)
      Sets the value of CfnDBClusterMixinProps.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 an Amazon DocumentDB 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 CfnDBClusterMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDBClusterMixinProps.getTags()
      Parameters:
      tags - The tags to be assigned to the cluster.
      Returns:
      this

    • useLatestRestorableTime

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

    • build

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