CreateDbClusterRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.CreateDbClusterRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDbClusterRequest
extends RdsRequest
implements ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDbClusterRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDbClusterRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`availabilityZones()` A list of EC2 Availability Zones that instances in the DB cluster can be created in.
`Long`	`backtrackWindow()` The target backtrack window, in seconds.
`Integer`	`backupRetentionPeriod()` The number of days for which automated backups are retained.
`static CreateDbClusterRequest.Builder`	`builder()`
`String`	`characterSetName()` A value that indicates that the DB cluster should be associated with the specified CharacterSet.
`String`	`databaseName()` The name for your database of up to 64 alpha-numeric characters.
`String`	`dbClusterIdentifier()` The DB cluster identifier.
`String`	`dbClusterParameterGroupName()` The name of the DB cluster parameter group to associate with this DB cluster.
`String`	`dbSubnetGroupName()` A DB subnet group to associate with this DB cluster.
`Boolean`	`deletionProtection()` Indicates if the DB cluster should have deletion protection enabled.
`List<String>`	`enableCloudwatchLogsExports()` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`Boolean`	`enableIAMDatabaseAuthentication()` True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
`String`	`engine()` The name of the database engine to be used for this DB cluster.
`String`	`engineMode()` The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, or `global`.
`String`	`engineVersion()` The version number of the database engine to use.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`globalClusterIdentifier()` The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
`int`	`hashCode()`
`String`	`kmsKeyId()` The AWS KMS key identifier for an encrypted DB cluster.
`String`	`masterUsername()` The name of the master user for the DB cluster.
`String`	`masterUserPassword()` The password for the master database user.
`String`	`optionGroupName()` A value that indicates that the DB cluster should be associated with the specified option group.
`Integer`	`port()` The port number on which the instances in the DB cluster accept connections.
`String`	`preferredBackupWindow()` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`String`	`preferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`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.
`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.
`ScalingConfiguration`	`scalingConfiguration()` For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDbClusterRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`storageEncrypted()` Specifies whether the DB cluster is encrypted.
`List<Tag>`	`tags()` Returns the value of the Tags property for this object.
`CreateDbClusterRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`vpcSecurityGroupIds()` A list of EC2 VPC security groups to associate with this DB cluster.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - availabilityZones
```
public List<String> availabilityZones()
```
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
  - backupRetentionPeriod
```
public Integer 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:
    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
  - characterSetName
```
public String characterSetName()
```
    A value that indicates that the DB cluster should be associated with the specified CharacterSet.
    
    Returns:
    
    A value that indicates that the DB cluster should be associated with the specified CharacterSet.
  - databaseName
```
public String databaseName()
```
    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
    
    Returns:
    
    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
  - dbClusterIdentifier
```
public 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
    Returns:
    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
  - dbClusterParameterGroupName
```
public String dbClusterParameterGroupName()
```
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used.
    
    Constraints:
    - If supplied, must match the name of an existing DB cluster parameter group.
    Returns:
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used.
    
    Constraints:
    
    If supplied, must match the name of an existing DB cluster parameter group.
  - vpcSecurityGroupIds
```
public List<String> vpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with this DB cluster.
  - dbSubnetGroupName
```
public 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
    
    Returns:
    
    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
  - engine
```
public 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
    
    Returns:
    
    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
  - engineVersion
```
public String engineVersion()
```
    The version number of the database engine to use.
    
    Aurora MySQL
    
    Example: 5.6.10a, 5.7.12
    
    Aurora PostgreSQL
    
    Example: 9.6.3
    
    Returns:
    
    The version number of the database engine to use.
    
    Aurora MySQL
    
    Example: 5.6.10a, 5.7.12
    
    Aurora PostgreSQL
    
    Example: 9.6.3
  - port
```
public 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.
    
    Returns:
    
    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.
  - masterUsername
```
public 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.
    Returns:
    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.
  - masterUserPassword
```
public 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.
    
    Returns:
    
    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.
  - optionGroupName
```
public 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.
    
    Returns:
    
    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.
  - preferredBackupWindow
```
public 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 see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance 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:
    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 see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance 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.
  - preferredMaintenanceWindow
```
public 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.
    
    Returns:
    
    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.
  - replicationSourceIdentifier
```
public 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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
  - tags
```
public List<Tag> tags()
```
    Returns the value of the Tags property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The value of the Tags property for this object.
  - storageEncrypted
```
public Boolean storageEncrypted()
```
    Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key identifier for an encrypted DB cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
    
    If an encryption key is not specified in KmsKeyId:
    - If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
    - If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use 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 Region.
    
    If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
    Returns:
    The AWS KMS key identifier for an encrypted DB cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
    
    If an encryption key is not specified in KmsKeyId:
    
    If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
    
    If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use 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 Region.
    
    If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
  - preSignedUrl
```
public 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 KMS key 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.
    Returns:
    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 KMS key 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.
  - enableIAMDatabaseAuthentication
```
public Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Returns:
    
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
  - backtrackWindow
```
public Long backtrackWindow()
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Default: 0
    
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Returns:
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Default: 0
    
    Constraints:
    
    If specified, this value must be set to a number from 0 to 259,200 (72 hours).
  - enableCloudwatchLogsExports
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - engineMode
```
public String engineMode()
```
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.
    
    Returns:
    
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.
  - scalingConfiguration
```
public ScalingConfiguration scalingConfiguration()
```
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
    
    Returns:
    
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
  - deletionProtection
```
public Boolean deletionProtection()
```
    Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
    
    Returns:
    
    Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
  - globalClusterIdentifier
```
public String globalClusterIdentifier()
```
    The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
    
    Returns:
    
    The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
  - toBuilder
```
public CreateDbClusterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static CreateDbClusterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDbClusterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateDbClusterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

availabilityZones

backupRetentionPeriod

characterSetName

databaseName

dbClusterIdentifier

dbClusterParameterGroupName

vpcSecurityGroupIds

dbSubnetGroupName

engine

engineVersion

port

masterUsername

masterUserPassword

optionGroupName

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

tags

storageEncrypted

kmsKeyId

preSignedUrl

enableIAMDatabaseAuthentication

backtrackWindow

enableCloudwatchLogsExports

engineMode

scalingConfiguration

deletionProtection

globalClusterIdentifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields