CreateDbClusterRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>, RdsRequest.Builder, SdkBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDbClusterRequest
```
public static interface CreateDbClusterRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CreateDbClusterRequest.Builder`	`availabilityZones(Collection<String> availabilityZones)` A list of Availability Zones (AZs) where instances in the DB cluster can be created.
`CreateDbClusterRequest.Builder`	`availabilityZones(String... availabilityZones)` A list of Availability Zones (AZs) where instances in the DB cluster can be created.
`CreateDbClusterRequest.Builder`	`backtrackWindow(Long backtrackWindow)` The target backtrack window, in seconds.
`CreateDbClusterRequest.Builder`	`backupRetentionPeriod(Integer backupRetentionPeriod)` The number of days for which automated backups are retained.
`CreateDbClusterRequest.Builder`	`characterSetName(String characterSetName)` A value that indicates that the DB cluster should be associated with the specified CharacterSet.
`CreateDbClusterRequest.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
`CreateDbClusterRequest.Builder`	`databaseName(String databaseName)` The name for your database of up to 64 alphanumeric characters.
`CreateDbClusterRequest.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` The DB cluster identifier.
`CreateDbClusterRequest.Builder`	`dbClusterParameterGroupName(String dbClusterParameterGroupName)` The name of the DB cluster parameter group to associate with this DB cluster.
`CreateDbClusterRequest.Builder`	`dbSubnetGroupName(String dbSubnetGroupName)` A DB subnet group to associate with this DB cluster.
`CreateDbClusterRequest.Builder`	`deletionProtection(Boolean deletionProtection)` A value that indicates whether the DB cluster has deletion protection enabled.
`CreateDbClusterRequest.Builder`	`domain(String domain)` The Active Directory directory ID to create the DB cluster in.
`CreateDbClusterRequest.Builder`	`domainIAMRoleName(String domainIAMRoleName)` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`CreateDbClusterRequest.Builder`	`enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`CreateDbClusterRequest.Builder`	`enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`CreateDbClusterRequest.Builder`	`enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)` A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster).
`CreateDbClusterRequest.Builder`	`enableHttpEndpoint(Boolean enableHttpEndpoint)` A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
`CreateDbClusterRequest.Builder`	`enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`CreateDbClusterRequest.Builder`	`engine(String engine)` The name of the database engine to be used for this DB cluster.
`CreateDbClusterRequest.Builder`	`engineMode(String engineMode)` The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`.
`CreateDbClusterRequest.Builder`	`engineVersion(String engineVersion)` The version number of the database engine to use.
`CreateDbClusterRequest.Builder`	`globalClusterIdentifier(String globalClusterIdentifier)` The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
`CreateDbClusterRequest.Builder`	`kmsKeyId(String kmsKeyId)` The AWS KMS key identifier for an encrypted DB cluster.
`CreateDbClusterRequest.Builder`	`masterUsername(String masterUsername)` The name of the master user for the DB cluster.
`CreateDbClusterRequest.Builder`	`masterUserPassword(String masterUserPassword)` The password for the master database user.
`CreateDbClusterRequest.Builder`	`optionGroupName(String optionGroupName)` A value that indicates that the DB cluster should be associated with the specified option group.
`CreateDbClusterRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CreateDbClusterRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CreateDbClusterRequest.Builder`	`port(Integer port)` The port number on which the instances in the DB cluster accept connections.
`CreateDbClusterRequest.Builder`	`preferredBackupWindow(String preferredBackupWindow)` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`CreateDbClusterRequest.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`CreateDbClusterRequest.Builder`	`preSignedUrl(String preSignedUrl)` A URL that contains a Signature Version 4 signed request for the `CreateDBCluster` action to be called in the source AWS Region where the DB cluster is replicated from.
`CreateDbClusterRequest.Builder`	`replicationSourceIdentifier(String replicationSourceIdentifier)` The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
`default CreateDbClusterRequest.Builder`	`scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)` For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.
`CreateDbClusterRequest.Builder`	`scalingConfiguration(ScalingConfiguration scalingConfiguration)` For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.
`CreateDbClusterRequest.Builder`	`sourceRegion(String sourceRegion)` If PreSignedUrl is not specified, this is the region where the source snapshot is located.
`CreateDbClusterRequest.Builder`	`storageEncrypted(Boolean storageEncrypted)` A value that indicates whether the DB cluster is encrypted.
`CreateDbClusterRequest.Builder`	`tags(Collection<Tag> tags)` Tags to assign to the DB cluster.
`CreateDbClusterRequest.Builder`	`tags(Consumer<Tag.Builder>... tags)` Tags to assign to the DB cluster.
`CreateDbClusterRequest.Builder`	`tags(Tag... tags)` Tags to assign to the DB cluster.
`CreateDbClusterRequest.Builder`	`vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB cluster.
`CreateDbClusterRequest.Builder`	`vpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB cluster.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - availabilityZones
```
CreateDbClusterRequest.Builder availabilityZones(Collection<String> availabilityZones)
```
    A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
    
    Parameters:
    
    availabilityZones - A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - availabilityZones
```
CreateDbClusterRequest.Builder availabilityZones(String... availabilityZones)
```
    A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
    
    Parameters:
    
    availabilityZones - A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backupRetentionPeriod
```
CreateDbClusterRequest.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
```
    The number of days for which automated backups are retained.
    
    Default: 1
    
    Constraints:
    - Must be a value from 1 to 35
    Parameters:
    backupRetentionPeriod - The number of days for which automated backups are retained.
    
    Default: 1
    
    Constraints:
    
    Must be a value from 1 to 35
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - characterSetName
```
CreateDbClusterRequest.Builder characterSetName(String characterSetName)
```
    A value that indicates that the DB cluster should be associated with the specified CharacterSet.
    
    Parameters:
    
    characterSetName - A value that indicates that the DB cluster should be associated with the specified CharacterSet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - databaseName
```
CreateDbClusterRequest.Builder databaseName(String databaseName)
```
    The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
    
    Parameters:
    
    databaseName - The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbClusterIdentifier
```
CreateDbClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)
```
    The DB cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - First character must be a letter.
    - Can't end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster1
    Parameters:
    dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    First character must be a letter.
    
    Can't end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster1
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbClusterParameterGroupName
```
CreateDbClusterRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
```
    The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
    
    Constraints:
    - If supplied, must match the name of an existing DB cluster parameter group.
    Parameters:
    dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
    
    Constraints:
    
    If supplied, must match the name of an existing DB cluster parameter group.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroupIds
```
CreateDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroupIds
```
CreateDbClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSubnetGroupName
```
CreateDbClusterRequest.Builder dbSubnetGroupName(String dbSubnetGroupName)
```
    A DB subnet group to associate with this DB cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dbSubnetGroupName - A DB subnet group to associate with this DB cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engine
```
CreateDbClusterRequest.Builder engine(String engine)
```
    The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
    
    Parameters:
    
    engine - The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineVersion
```
CreateDbClusterRequest.Builder engineVersion(String engineVersion)
```
    The version number of the database engine to use.
    
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-postgresql, use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
    
    Aurora MySQL
    
    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5
    
    Aurora PostgreSQL
    
    Example: 9.6.3, 10.7
    
    Parameters:
    
    engineVersion - The version number of the database engine to use.
    
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-postgresql, use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
    
    Aurora MySQL
    
    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5
    
    Aurora PostgreSQL
    
    Example: 9.6.3, 10.7
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - port
```
CreateDbClusterRequest.Builder port(Integer port)
```
    The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
    
    Parameters:
    
    port - The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - masterUsername
```
CreateDbClusterRequest.Builder masterUsername(String masterUsername)
```
    The name of the master user for the DB cluster.
    
    Constraints:
    - Must be 1 to 16 letters or numbers.
    - First character must be a letter.
    - Can't be a reserved word for the chosen database engine.
    Parameters:
    masterUsername - The name of the master user for the DB cluster.
    
    Constraints:
    
    Must be 1 to 16 letters or numbers.
    
    First character must be a letter.
    
    Can't be a reserved word for the chosen database engine.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - masterUserPassword
```
CreateDbClusterRequest.Builder masterUserPassword(String masterUserPassword)
```
    The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
    
    Constraints: Must contain from 8 to 41 characters.
    
    Parameters:
    
    masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
    
    Constraints: Must contain from 8 to 41 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - optionGroupName
```
CreateDbClusterRequest.Builder optionGroupName(String optionGroupName)
```
    A value that indicates that the DB cluster should be associated with the specified option group.
    
    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
    
    Parameters:
    
    optionGroupName - A value that indicates that the DB cluster should be associated with the specified option group.
    
    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - preferredBackupWindow
```
CreateDbClusterRequest.Builder preferredBackupWindow(String 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. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
    
    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.
    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. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - preferredMaintenanceWindow
```
CreateDbClusterRequest.Builder preferredMaintenanceWindow(String 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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
    
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    
    Constraints: Minimum 30-minute window.
    
    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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
    
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    
    Constraints: Minimum 30-minute window.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationSourceIdentifier
```
CreateDbClusterRequest.Builder replicationSourceIdentifier(String replicationSourceIdentifier)
```
    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
    
    Parameters:
    
    replicationSourceIdentifier - The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
CreateDbClusterRequest.Builder tags(Collection<Tag> tags)
```
    Tags to assign to the DB cluster.
    
    Parameters:
    
    tags - Tags to assign to the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
CreateDbClusterRequest.Builder tags(Tag... tags)
```
    Tags to assign to the DB cluster.
    
    Parameters:
    
    tags - Tags to assign to the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
CreateDbClusterRequest.Builder tags(Consumer<Tag.Builder>... tags)
```
    Tags to assign to the DB cluster.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - storageEncrypted
```
CreateDbClusterRequest.Builder storageEncrypted(Boolean storageEncrypted)
```
    A value that indicates whether the DB cluster is encrypted.
    
    Parameters:
    
    storageEncrypted - A value that indicates whether the DB cluster is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - kmsKeyId
```
CreateDbClusterRequest.Builder kmsKeyId(String kmsKeyId)
```
    The AWS KMS key identifier for an encrypted DB cluster.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN.
    
    When a CMK isn't specified in KmsKeyId:
    - If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.
    - If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.
    There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
    
    If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.
    Parameters:
    kmsKeyId - The AWS KMS key identifier for an encrypted DB cluster.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN.
    
    When a CMK isn't specified in KmsKeyId:
    
    If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.
    
    If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.
    
    There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
    
    If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - preSignedUrl
```
CreateDbClusterRequest.Builder preSignedUrl(String preSignedUrl)
```
    A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
    
    The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.
    
    The pre-signed URL request must contain the following parameter values:
    - KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
    - DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.
    - ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
    
    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
    Parameters:
    preSignedUrl - A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
    
    The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.
    
    The pre-signed URL request must contain the following parameter values:
    
    KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
    
    DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.
    
    ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
    
    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
    
    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableIAMDatabaseAuthentication
```
CreateDbClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backtrackWindow
```
CreateDbClusterRequest.Builder backtrackWindow(Long backtrackWindow)
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Parameters:
    backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    
    Constraints:
    
    If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCloudwatchLogsExports
```
CreateDbClusterRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
```
    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Aurora MySQL
    
    Possible values are audit, error, general, and slowquery.
    
    Aurora PostgreSQL
    
    Possible value is postgresql.
    
    Parameters:
    
    enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Aurora MySQL
    
    Possible values are audit, error, general, and slowquery.
    
    Aurora PostgreSQL
    
    Possible value is postgresql.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCloudwatchLogsExports
```
CreateDbClusterRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
```
    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Aurora MySQL
    
    Possible values are audit, error, general, and slowquery.
    
    Aurora PostgreSQL
    
    Possible value is postgresql.
    
    Parameters:
    
    enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Aurora MySQL
    
    Possible values are audit, error, general, and slowquery.
    
    Aurora PostgreSQL
    
    Possible value is postgresql.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineMode
```
CreateDbClusterRequest.Builder engineMode(String engineMode)
```
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
    
    The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
    
    The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
    
    The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
    
    For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
    
    Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
    Parameters:
    engineMode - The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
    
    The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
    
    The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
    
    The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
    
    For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
    
    Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
    
    Limitations of Aurora Serverless
    
    Limitations of Parallel Query
    
    Limitations of Aurora Global Databases
    
    Limitations of Multi-Master Clusters
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scalingConfiguration
```
CreateDbClusterRequest.Builder scalingConfiguration(ScalingConfiguration scalingConfiguration)
```
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
    
    Parameters:
    
    scalingConfiguration - For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scalingConfiguration
```
default CreateDbClusterRequest.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)
```
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
    This is a convenience that creates an instance of the ScalingConfiguration.Builder avoiding the need to create one manually via ScalingConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfiguration(ScalingConfiguration).
    
    Parameters:
    
    scalingConfiguration - a consumer that will call methods on ScalingConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    scalingConfiguration(ScalingConfiguration)
  - deletionProtection
```
CreateDbClusterRequest.Builder deletionProtection(Boolean deletionProtection)
```
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    
    Parameters:
    
    deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - globalClusterIdentifier
```
CreateDbClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)
```
    The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
    
    Parameters:
    
    globalClusterIdentifier - The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableHttpEndpoint
```
CreateDbClusterRequest.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
```
    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableHttpEndpoint - A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - copyTagsToSnapshot
```
CreateDbClusterRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
    
    Parameters:
    
    copyTagsToSnapshot - A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domain
```
CreateDbClusterRequest.Builder domain(String domain)
```
    The Active Directory directory ID to create the DB cluster in.
    
    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
    
    Parameters:
    
    domain - The Active Directory directory ID to create the DB cluster in.
    
    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domainIAMRoleName
```
CreateDbClusterRequest.Builder domainIAMRoleName(String domainIAMRoleName)
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Parameters:
    
    domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableGlobalWriteForwarding
```
CreateDbClusterRequest.Builder enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
```
    A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    
    You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
    
    Parameters:
    
    enableGlobalWriteForwarding - A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
    
    You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sourceRegion
```
CreateDbClusterRequest.Builder sourceRegion(String sourceRegion)
```
    If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.
    
    Parameters:
    
    sourceRegion - If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
CreateDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CreateDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CreateDbClusterRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

availabilityZones

availabilityZones

backupRetentionPeriod

characterSetName

databaseName

dbClusterIdentifier

dbClusterParameterGroupName

vpcSecurityGroupIds

vpcSecurityGroupIds

dbSubnetGroupName

engine

engineVersion

port

masterUsername

masterUserPassword

optionGroupName

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

tags

tags

tags

storageEncrypted

kmsKeyId

preSignedUrl

enableIAMDatabaseAuthentication

backtrackWindow

enableCloudwatchLogsExports

enableCloudwatchLogsExports

engineMode

scalingConfiguration

scalingConfiguration

deletionProtection

globalClusterIdentifier

enableHttpEndpoint

copyTagsToSnapshot

domain

domainIAMRoleName

enableGlobalWriteForwarding

sourceRegion

overrideConfiguration

overrideConfiguration