CreateDBClusterRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.CreateDBClusterRequest

All Implemented Interfaces:: ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDBClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateDBClusterRequest()

Constructors
Constructor and Description
`CreateDBClusterRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateDBClusterRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`List<String>`	`getAvailabilityZones()` A list of EC2 Availability Zones that instances in the DB cluster can be created in.
`Integer`	`getBackupRetentionPeriod()` The number of days for which automated backups are retained.
`String`	`getCharacterSetName()` A value that indicates that the DB cluster should be associated with the specified CharacterSet.
`String`	`getDatabaseName()` The name for your database of up to 8 alpha-numeric characters.
`String`	`getDBClusterIdentifier()` The DB cluster identifier.
`String`	`getDBClusterParameterGroupName()` The name of the DB cluster parameter group to associate with this DB cluster.
`String`	`getDBSubnetGroupName()` A DB subnet group to associate with this DB cluster.
`String`	`getEngine()` The name of the database engine to be used for this DB cluster.
`String`	`getEngineVersion()` The version number of the database engine to use.
`String`	`getKmsKeyId()` The KMS key identifier for an encrypted DB cluster.
`String`	`getMasterUsername()` The name of the master user for the DB cluster.
`String`	`getMasterUserPassword()` The password for the master database user.
`String`	`getOptionGroupName()` A value that indicates that the DB cluster should be associated with the specified option group.
`Integer`	`getPort()` The port number on which the instances in the DB cluster accept connections.
`String`	`getPreferredBackupWindow()` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`String`	`getReplicationSourceIdentifier()` The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
`Boolean`	`getStorageEncrypted()` Specifies whether the DB cluster is encrypted.
`List<Tag>`	`getTags()`
`List<String>`	`getVpcSecurityGroupIds()` A list of EC2 VPC security groups to associate with this DB cluster.
`int`	`hashCode()`
`Boolean`	`isStorageEncrypted()` Specifies whether the DB cluster is encrypted.
`void`	`setAvailabilityZones(Collection<String> availabilityZones)` A list of EC2 Availability Zones that instances in the DB cluster can be created in.
`void`	`setBackupRetentionPeriod(Integer backupRetentionPeriod)` The number of days for which automated backups are retained.
`void`	`setCharacterSetName(String characterSetName)` A value that indicates that the DB cluster should be associated with the specified CharacterSet.
`void`	`setDatabaseName(String databaseName)` The name for your database of up to 8 alpha-numeric characters.
`void`	`setDBClusterIdentifier(String dBClusterIdentifier)` The DB cluster identifier.
`void`	`setDBClusterParameterGroupName(String dBClusterParameterGroupName)` The name of the DB cluster parameter group to associate with this DB cluster.
`void`	`setDBSubnetGroupName(String dBSubnetGroupName)` A DB subnet group to associate with this DB cluster.
`void`	`setEngine(String engine)` The name of the database engine to be used for this DB cluster.
`void`	`setEngineVersion(String engineVersion)` The version number of the database engine to use.
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier for an encrypted DB cluster.
`void`	`setMasterUsername(String masterUsername)` The name of the master user for the DB cluster.
`void`	`setMasterUserPassword(String masterUserPassword)` The password for the master database user.
`void`	`setOptionGroupName(String optionGroupName)` A value that indicates that the DB cluster should be associated with the specified option group.
`void`	`setPort(Integer port)` The port number on which the instances in the DB cluster accept connections.
`void`	`setPreferredBackupWindow(String preferredBackupWindow)` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`void`	`setPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`void`	`setReplicationSourceIdentifier(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.
`void`	`setStorageEncrypted(Boolean storageEncrypted)` Specifies whether the DB cluster is encrypted.
`void`	`setTags(Collection<Tag> tags)`
`void`	`setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB cluster.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateDBClusterRequest`	`withAvailabilityZones(Collection<String> availabilityZones)` A list of EC2 Availability Zones that instances in the DB cluster can be created in.
`CreateDBClusterRequest`	`withAvailabilityZones(String... availabilityZones)` A list of EC2 Availability Zones that instances in the DB cluster can be created in.
`CreateDBClusterRequest`	`withBackupRetentionPeriod(Integer backupRetentionPeriod)` The number of days for which automated backups are retained.
`CreateDBClusterRequest`	`withCharacterSetName(String characterSetName)` A value that indicates that the DB cluster should be associated with the specified CharacterSet.
`CreateDBClusterRequest`	`withDatabaseName(String databaseName)` The name for your database of up to 8 alpha-numeric characters.
`CreateDBClusterRequest`	`withDBClusterIdentifier(String dBClusterIdentifier)` The DB cluster identifier.
`CreateDBClusterRequest`	`withDBClusterParameterGroupName(String dBClusterParameterGroupName)` The name of the DB cluster parameter group to associate with this DB cluster.
`CreateDBClusterRequest`	`withDBSubnetGroupName(String dBSubnetGroupName)` A DB subnet group to associate with this DB cluster.
`CreateDBClusterRequest`	`withEngine(String engine)` The name of the database engine to be used for this DB cluster.
`CreateDBClusterRequest`	`withEngineVersion(String engineVersion)` The version number of the database engine to use.
`CreateDBClusterRequest`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier for an encrypted DB cluster.
`CreateDBClusterRequest`	`withMasterUsername(String masterUsername)` The name of the master user for the DB cluster.
`CreateDBClusterRequest`	`withMasterUserPassword(String masterUserPassword)` The password for the master database user.
`CreateDBClusterRequest`	`withOptionGroupName(String optionGroupName)` A value that indicates that the DB cluster should be associated with the specified option group.
`CreateDBClusterRequest`	`withPort(Integer port)` The port number on which the instances in the DB cluster accept connections.
`CreateDBClusterRequest`	`withPreferredBackupWindow(String preferredBackupWindow)` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`CreateDBClusterRequest`	`withPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`CreateDBClusterRequest`	`withReplicationSourceIdentifier(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.
`CreateDBClusterRequest`	`withStorageEncrypted(Boolean storageEncrypted)` Specifies whether the DB cluster is encrypted.
`CreateDBClusterRequest`	`withTags(Collection<Tag> tags)`
`CreateDBClusterRequest`	`withTags(Tag... tags)` NOTE: This method appends the values to the existing list (if any).
`CreateDBClusterRequest`	`withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB cluster.
`CreateDBClusterRequest`	`withVpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB cluster.

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

- Constructor Detail
  - CreateDBClusterRequest
```
public CreateDBClusterRequest()
```
- Method Detail
  - getAvailabilityZones
```
public List<String> getAvailabilityZones()
```
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
    
    Returns:
    
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
  - setAvailabilityZones
```
public void setAvailabilityZones(Collection<String> availabilityZones)
```
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
    
    Parameters:
    
    availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
  - withAvailabilityZones
```
public CreateDBClusterRequest withAvailabilityZones(String... availabilityZones)
```
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
    
    NOTE: This method appends the values to the existing list (if any). Use setAvailabilityZones(java.util.Collection) or withAvailabilityZones(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAvailabilityZones
```
public CreateDBClusterRequest withAvailabilityZones(Collection<String> availabilityZones)
```
    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
    
    Parameters:
    
    availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupRetentionPeriod
```
public void setBackupRetentionPeriod(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
    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
  - getBackupRetentionPeriod
```
public Integer getBackupRetentionPeriod()
```
    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
  - withBackupRetentionPeriod
```
public CreateDBClusterRequest withBackupRetentionPeriod(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
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCharacterSetName
```
public void setCharacterSetName(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.
  - getCharacterSetName
```
public String getCharacterSetName()
```
    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.
  - withCharacterSetName
```
public CreateDBClusterRequest withCharacterSetName(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.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
    
    Parameters:
    
    databaseName - The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
  - getDatabaseName
```
public String getDatabaseName()
```
    The name for your database of up to 8 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 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
  - withDatabaseName
```
public CreateDBClusterRequest withDatabaseName(String databaseName)
```
    The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
    
    Parameters:
    
    databaseName - The name for your database of up to 8 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterIdentifier
```
public void setDBClusterIdentifier(String dBClusterIdentifier)
```
    The DB cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot 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 alphanumeric characters or hyphens.
    
    First character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster1
  - getDBClusterIdentifier
```
public String getDBClusterIdentifier()
```
    The DB cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot 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 alphanumeric characters or hyphens.
    
    First character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster1
  - withDBClusterIdentifier
```
public CreateDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)
```
    The DB cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot 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 alphanumeric characters or hyphens.
    
    First character must be a letter.
    
    Cannot 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.
  - setDBClusterParameterGroupName
```
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
```
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.
    
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Parameters:
    dBClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.
    
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - getDBClusterParameterGroupName
```
public String getDBClusterParameterGroupName()
```
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.
    
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.
    
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - withDBClusterParameterGroupName
```
public CreateDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
```
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.
    
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Parameters:
    dBClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.
    
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroupIds
```
public List<String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with this DB cluster.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(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.
  - withVpcSecurityGroupIds
```
public CreateDBClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    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.
  - withVpcSecurityGroupIds
```
public CreateDBClusterRequest withVpcSecurityGroupIds(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.
  - setDBSubnetGroupName
```
public void setDBSubnetGroupName(String dBSubnetGroupName)
```
    A DB subnet group to associate with this DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dBSubnetGroupName - A DB subnet group to associate with this DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
  - getDBSubnetGroupName
```
public String getDBSubnetGroupName()
```
    A DB subnet group to associate with this DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
    
    Returns:
    
    A DB subnet group to associate with this DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
  - withDBSubnetGroupName
```
public CreateDBClusterRequest withDBSubnetGroupName(String dBSubnetGroupName)
```
    A DB subnet group to associate with this DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dBSubnetGroupName - A DB subnet group to associate with this DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngine
```
public void setEngine(String engine)
```
    The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora
    
    Parameters:
    
    engine - The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora
  - getEngine
```
public String getEngine()
```
    The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora
    
    Returns:
    
    The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora
  - withEngine
```
public CreateDBClusterRequest withEngine(String engine)
```
    The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora
    
    Parameters:
    
    engine - The name of the database engine to be used for this DB cluster.
    
    Valid Values: aurora
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    The version number of the database engine to use.
    
    Aurora
    
    Example: 5.6.10a
    
    Parameters:
    
    engineVersion - The version number of the database engine to use.
    
    Aurora
    
    Example: 5.6.10a
  - getEngineVersion
```
public String getEngineVersion()
```
    The version number of the database engine to use.
    
    Aurora
    
    Example: 5.6.10a
    
    Returns:
    
    The version number of the database engine to use.
    
    Aurora
    
    Example: 5.6.10a
  - withEngineVersion
```
public CreateDBClusterRequest withEngineVersion(String engineVersion)
```
    The version number of the database engine to use.
    
    Aurora
    
    Example: 5.6.10a
    
    Parameters:
    
    engineVersion - The version number of the database engine to use.
    
    Aurora
    
    Example: 5.6.10a
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306
    
    Parameters:
    
    port - The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306
  - getPort
```
public Integer getPort()
```
    The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306
    
    Returns:
    
    The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306
  - withPort
```
public CreateDBClusterRequest withPort(Integer port)
```
    The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306
    
    Parameters:
    
    port - The port number on which the instances in the DB cluster accept connections.
    
    Default: 3306
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMasterUsername
```
public void setMasterUsername(String masterUsername)
```
    The name of the master user for the DB cluster.
    
    Constraints:
    - Must be 1 to 16 alphanumeric characters.
    - First character must be a letter.
    - Cannot 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 alphanumeric characters.
    
    First character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
  - getMasterUsername
```
public String getMasterUsername()
```
    The name of the master user for the DB cluster.
    
    Constraints:
    - Must be 1 to 16 alphanumeric characters.
    - First character must be a letter.
    - Cannot 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 alphanumeric characters.
    
    First character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
  - withMasterUsername
```
public CreateDBClusterRequest withMasterUsername(String masterUsername)
```
    The name of the master user for the DB cluster.
    
    Constraints:
    - Must be 1 to 16 alphanumeric characters.
    - First character must be a letter.
    - Cannot 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 alphanumeric characters.
    
    First character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMasterUserPassword
```
public void setMasterUserPassword(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.
  - getMasterUserPassword
```
public String getMasterUserPassword()
```
    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.
  - withMasterUserPassword
```
public CreateDBClusterRequest withMasterUserPassword(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.
  - setOptionGroupName
```
public void setOptionGroupName(String optionGroupName)
```
    A value that indicates that the DB cluster should be associated with the specified option group.
    
    Permanent options cannot be removed from an option group. The option group cannot 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 cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
  - getOptionGroupName
```
public String getOptionGroupName()
```
    A value that indicates that the DB cluster should be associated with the specified option group.
    
    Permanent options cannot be removed from an option group. The option group cannot 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 cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
  - withOptionGroupName
```
public CreateDBClusterRequest withOptionGroupName(String optionGroupName)
```
    A value that indicates that the DB cluster should be associated with the specified option group.
    
    Permanent options cannot be removed from an option group. The option group cannot 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 cannot be removed from an option group. The option group cannot 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.
  - setPreferredBackupWindow
```
public void setPreferredBackupWindow(String preferredBackupWindow)
```
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Times should 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.
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Times should be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
  - getPreferredBackupWindow
```
public String getPreferredBackupWindow()
```
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Times should 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.
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Times should be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
  - withPreferredBackupWindow
```
public CreateDBClusterRequest withPreferredBackupWindow(String preferredBackupWindow)
```
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Times should 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.
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Times should 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.
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
    
    Constraints: Minimum 30-minute window.
  - getPreferredMaintenanceWindow
```
public String getPreferredMaintenanceWindow()
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
    
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
    
    Constraints: Minimum 30-minute window.
  - withPreferredMaintenanceWindow
```
public CreateDBClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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
    
    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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.
  - setReplicationSourceIdentifier
```
public void setReplicationSourceIdentifier(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.
  - getReplicationSourceIdentifier
```
public String getReplicationSourceIdentifier()
```
    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.
  - withReplicationSourceIdentifier
```
public CreateDBClusterRequest withReplicationSourceIdentifier(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.
  - getTags
```
public List<Tag> getTags()
```
    Returns:
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Parameters:
    
    tags -
  - withTags
```
public CreateDBClusterRequest withTags(Tag... tags)
```
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateDBClusterRequest withTags(Collection<Tag> tags)
```
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageEncrypted
```
public void setStorageEncrypted(Boolean storageEncrypted)
```
    Specifies whether the DB cluster is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the DB cluster is encrypted.
  - getStorageEncrypted
```
public Boolean getStorageEncrypted()
```
    Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - withStorageEncrypted
```
public CreateDBClusterRequest withStorageEncrypted(Boolean storageEncrypted)
```
    Specifies whether the DB cluster is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStorageEncrypted
```
public Boolean isStorageEncrypted()
```
    Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The 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 KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.
    
    Parameters:
    
    kmsKeyId - The 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 KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The 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 KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.
    
    Returns:
    
    The 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 KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.
  - withKmsKeyId
```
public CreateDBClusterRequest withKmsKeyId(String kmsKeyId)
```
    The 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 KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.
    
    Parameters:
    
    kmsKeyId - The 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 KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateDBClusterRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateDBClusterRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateDBClusterRequest

Method Detail

getAvailabilityZones

setAvailabilityZones

withAvailabilityZones

withAvailabilityZones

setBackupRetentionPeriod

getBackupRetentionPeriod

withBackupRetentionPeriod

setCharacterSetName

getCharacterSetName

withCharacterSetName

setDatabaseName

getDatabaseName

withDatabaseName

setDBClusterIdentifier

getDBClusterIdentifier

withDBClusterIdentifier

setDBClusterParameterGroupName

getDBClusterParameterGroupName

withDBClusterParameterGroupName

getVpcSecurityGroupIds

setVpcSecurityGroupIds

withVpcSecurityGroupIds

withVpcSecurityGroupIds

setDBSubnetGroupName

getDBSubnetGroupName

withDBSubnetGroupName

setEngine

getEngine

withEngine

setEngineVersion

getEngineVersion

withEngineVersion

setPort

getPort

withPort

setMasterUsername

getMasterUsername

withMasterUsername

setMasterUserPassword

getMasterUserPassword

withMasterUserPassword

setOptionGroupName

getOptionGroupName

withOptionGroupName

setPreferredBackupWindow

getPreferredBackupWindow

withPreferredBackupWindow

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

setReplicationSourceIdentifier

getReplicationSourceIdentifier

withReplicationSourceIdentifier

getTags

setTags

withTags

withTags

setStorageEncrypted

getStorageEncrypted

withStorageEncrypted

isStorageEncrypted

setKmsKeyId

getKmsKeyId

withKmsKeyId

toString

equals

hashCode

clone