CreateDBClusterRequest (AWS SDK for Java

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDBClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input to CreateDBCluster.

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 object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getAvailabilityZones()` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`Integer`	`getBackupRetentionPeriod()` The number of days for which automated backups are retained.
`String`	`getDBClusterIdentifier()` The cluster identifier.
`String`	`getDBClusterParameterGroupName()` The name of the cluster parameter group to associate with this cluster.
`String`	`getDBSubnetGroupName()` A subnet group to associate with this cluster.
`Boolean`	`getDeletionProtection()` Specifies whether this cluster can be deleted.
`List<String>`	`getEnableCloudwatchLogsExports()` A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`String`	`getEngine()` The name of the database engine to be used for this cluster.
`String`	`getEngineVersion()` The version number of the database engine to use.
`String`	`getGlobalClusterIdentifier()` The cluster identifier of the new global cluster.
`String`	`getKmsKeyId()` The KMS key identifier for an encrypted cluster.
`String`	`getMasterUsername()` The name of the master user for the cluster.
`String`	`getMasterUserPassword()` The password for the master database user.
`Integer`	`getPort()` The port number on which the instances in the 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`	`getPreSignedUrl()` Not currently supported.
`String`	`getSourceRegion()` The region where the source instance is located.
`Boolean`	`getStorageEncrypted()` Specifies whether the cluster is encrypted.
`String`	`getStorageType()` The storage type to associate with the DB cluster.
`List<Tag>`	`getTags()` The tags to be assigned to the cluster.
`List<String>`	`getVpcSecurityGroupIds()` A list of EC2 VPC security groups to associate with this cluster.
`int`	`hashCode()`
`Boolean`	`isDeletionProtection()` Specifies whether this cluster can be deleted.
`Boolean`	`isStorageEncrypted()` Specifies whether the cluster is encrypted.
`void`	`setAvailabilityZones(Collection<String> availabilityZones)` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`void`	`setBackupRetentionPeriod(Integer backupRetentionPeriod)` The number of days for which automated backups are retained.
`void`	`setDBClusterIdentifier(String dBClusterIdentifier)` The cluster identifier.
`void`	`setDBClusterParameterGroupName(String dBClusterParameterGroupName)` The name of the cluster parameter group to associate with this cluster.
`void`	`setDBSubnetGroupName(String dBSubnetGroupName)` A subnet group to associate with this cluster.
`void`	`setDeletionProtection(Boolean deletionProtection)` Specifies whether this cluster can be deleted.
`void`	`setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)` A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`void`	`setEngine(String engine)` The name of the database engine to be used for this cluster.
`void`	`setEngineVersion(String engineVersion)` The version number of the database engine to use.
`void`	`setGlobalClusterIdentifier(String globalClusterIdentifier)` The cluster identifier of the new global cluster.
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier for an encrypted cluster.
`void`	`setMasterUsername(String masterUsername)` The name of the master user for the cluster.
`void`	`setMasterUserPassword(String masterUserPassword)` The password for the master database user.
`void`	`setPort(Integer port)` The port number on which the instances in the 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`	`setPreSignedUrl(String preSignedUrl)` Not currently supported.
`void`	`setSourceRegion(String sourceRegion)` The region where the source instance is located.
`void`	`setStorageEncrypted(Boolean storageEncrypted)` Specifies whether the cluster is encrypted.
`void`	`setStorageType(String storageType)` The storage type to associate with the DB cluster.
`void`	`setTags(Collection<Tag> tags)` The tags to be assigned to the cluster.
`void`	`setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this cluster.
`String`	`toString()` Returns a string representation of this object.
`CreateDBClusterRequest`	`withAvailabilityZones(Collection<String> availabilityZones)` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`CreateDBClusterRequest`	`withAvailabilityZones(String... availabilityZones)` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`CreateDBClusterRequest`	`withBackupRetentionPeriod(Integer backupRetentionPeriod)` The number of days for which automated backups are retained.
`CreateDBClusterRequest`	`withDBClusterIdentifier(String dBClusterIdentifier)` The cluster identifier.
`CreateDBClusterRequest`	`withDBClusterParameterGroupName(String dBClusterParameterGroupName)` The name of the cluster parameter group to associate with this cluster.
`CreateDBClusterRequest`	`withDBSubnetGroupName(String dBSubnetGroupName)` A subnet group to associate with this cluster.
`CreateDBClusterRequest`	`withDeletionProtection(Boolean deletionProtection)` Specifies whether this cluster can be deleted.
`CreateDBClusterRequest`	`withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)` A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`CreateDBClusterRequest`	`withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)` A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`CreateDBClusterRequest`	`withEngine(String engine)` The name of the database engine to be used for this cluster.
`CreateDBClusterRequest`	`withEngineVersion(String engineVersion)` The version number of the database engine to use.
`CreateDBClusterRequest`	`withGlobalClusterIdentifier(String globalClusterIdentifier)` The cluster identifier of the new global cluster.
`CreateDBClusterRequest`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier for an encrypted cluster.
`CreateDBClusterRequest`	`withMasterUsername(String masterUsername)` The name of the master user for the cluster.
`CreateDBClusterRequest`	`withMasterUserPassword(String masterUserPassword)` The password for the master database user.
`CreateDBClusterRequest`	`withPort(Integer port)` The port number on which the instances in the 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`	`withPreSignedUrl(String preSignedUrl)` Not currently supported.
`CreateDBClusterRequest`	`withSourceRegion(String sourceRegion)` The region where the source instance is located.
`CreateDBClusterRequest`	`withStorageEncrypted(Boolean storageEncrypted)` Specifies whether the cluster is encrypted.
`CreateDBClusterRequest`	`withStorageType(String storageType)` The storage type to associate with the DB cluster.
`CreateDBClusterRequest`	`withTags(Collection<Tag> tags)` The tags to be assigned to the cluster.
`CreateDBClusterRequest`	`withTags(Tag... tags)` The tags to be assigned to the cluster.
`CreateDBClusterRequest`	`withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this cluster.
`CreateDBClusterRequest`	`withVpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this 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 Amazon EC2 Availability Zones that instances in the cluster can be created in.
    
    Returns:
    
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - setAvailabilityZones
```
public void setAvailabilityZones(Collection<String> availabilityZones)
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
    
    Parameters:
    
    availabilityZones - A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - withAvailabilityZones
```
public CreateDBClusterRequest withAvailabilityZones(String... availabilityZones)
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
    
    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 Amazon EC2 Availability Zones that instances in the cluster can be created in.
    
    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 Amazon EC2 Availability Zones that instances in the cluster can be created in.
    
    Parameters:
    
    availabilityZones - A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
    
    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.
  - setDBClusterIdentifier
```
public void setDBClusterIdentifier(String dBClusterIdentifier)
```
    The cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - The first character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster
    Parameters:
    dBClusterIdentifier - The cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    The first character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster
  - getDBClusterIdentifier
```
public String getDBClusterIdentifier()
```
    The cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - The first character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster
    Returns:
    The cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    The first character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster
  - withDBClusterIdentifier
```
public CreateDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)
```
    The cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - The first character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster
    Parameters:
    dBClusterIdentifier - The cluster identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    The first character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterParameterGroupName
```
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
```
    The name of the cluster parameter group to associate with this cluster.
    
    Parameters:
    
    dBClusterParameterGroupName - The name of the cluster parameter group to associate with this cluster.
  - getDBClusterParameterGroupName
```
public String getDBClusterParameterGroupName()
```
    The name of the cluster parameter group to associate with this cluster.
    
    Returns:
    
    The name of the cluster parameter group to associate with this cluster.
  - withDBClusterParameterGroupName
```
public CreateDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
```
    The name of the cluster parameter group to associate with this cluster.
    
    Parameters:
    
    dBClusterParameterGroupName - The name of the cluster parameter group to associate with this cluster.
    
    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 cluster.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with this cluster.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with this cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this cluster.
  - withVpcSecurityGroupIds
```
public CreateDBClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with this 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 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 cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBSubnetGroupName
```
public void setDBSubnetGroupName(String dBSubnetGroupName)
```
    A subnet group to associate with this cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dBSubnetGroupName - A subnet group to associate with this cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
  - getDBSubnetGroupName
```
public String getDBSubnetGroupName()
```
    A subnet group to associate with this cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
    
    Returns:
    
    A subnet group to associate with this cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
  - withDBSubnetGroupName
```
public CreateDBClusterRequest withDBSubnetGroupName(String dBSubnetGroupName)
```
    A subnet group to associate with this cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dBSubnetGroupName - A subnet group to associate with this cluster.
    
    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
    
    Example: mySubnetgroup
    
    Returns:
    
    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 cluster.
    
    Valid values: docdb
    
    Parameters:
    
    engine - The name of the database engine to be used for this cluster.
    
    Valid values: docdb
  - getEngine
```
public String getEngine()
```
    The name of the database engine to be used for this cluster.
    
    Valid values: docdb
    
    Returns:
    
    The name of the database engine to be used for this cluster.
    
    Valid values: docdb
  - withEngine
```
public CreateDBClusterRequest withEngine(String engine)
```
    The name of the database engine to be used for this cluster.
    
    Valid values: docdb
    
    Parameters:
    
    engine - The name of the database engine to be used for this cluster.
    
    Valid values: docdb
    
    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. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
    
    Parameters:
    
    engineVersion - The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
  - getEngineVersion
```
public String getEngineVersion()
```
    The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
    
    Returns:
    
    The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
  - withEngineVersion
```
public CreateDBClusterRequest withEngineVersion(String engineVersion)
```
    The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
    
    Parameters:
    
    engineVersion - The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
    
    Returns:
    
    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 cluster accept connections.
    
    Parameters:
    
    port - The port number on which the instances in the cluster accept connections.
  - getPort
```
public Integer getPort()
```
    The port number on which the instances in the cluster accept connections.
    
    Returns:
    
    The port number on which the instances in the cluster accept connections.
  - withPort
```
public CreateDBClusterRequest withPort(Integer port)
```
    The port number on which the instances in the cluster accept connections.
    
    Parameters:
    
    port - The port number on which the instances in the cluster accept connections.
    
    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 cluster.
    
    Constraints:
    - Must be from 1 to 63 letters or numbers.
    - The first character must be a letter.
    - Cannot be a reserved word for the chosen database engine.
    Parameters:
    masterUsername - The name of the master user for the cluster.
    
    Constraints:
    
    Must be from 1 to 63 letters or numbers.
    
    The first character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
  - getMasterUsername
```
public String getMasterUsername()
```
    The name of the master user for the cluster.
    
    Constraints:
    - Must be from 1 to 63 letters or numbers.
    - The first character must be a letter.
    - Cannot be a reserved word for the chosen database engine.
    Returns:
    The name of the master user for the cluster.
    
    Constraints:
    
    Must be from 1 to 63 letters or numbers.
    
    The first character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
  - withMasterUsername
```
public CreateDBClusterRequest withMasterUsername(String masterUsername)
```
    The name of the master user for the cluster.
    
    Constraints:
    - Must be from 1 to 63 letters or numbers.
    - The first character must be a letter.
    - Cannot be a reserved word for the chosen database engine.
    Parameters:
    masterUsername - The name of the master user for the cluster.
    
    Constraints:
    
    Must be from 1 to 63 letters or numbers.
    
    The first character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
    Returns:
    
    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 forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
    
    Parameters:
    
    masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
  - getMasterUserPassword
```
public String getMasterUserPassword()
```
    The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
    
    Returns:
    
    The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
  - withMasterUserPassword
```
public CreateDBClusterRequest withMasterUserPassword(String masterUserPassword)
```
    The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
    
    Parameters:
    
    masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
    
    Returns:
    
    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.
    
    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Must be in Universal Coordinated Time (UTC).
    - Must not conflict with the preferred maintenance window.
    - Must be at least 30 minutes.
    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 Amazon Web Services Region.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Must be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
  - getPreferredBackupWindow
```
public String getPreferredBackupWindow()
```
    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 Amazon Web Services Region.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Must be in Universal Coordinated Time (UTC).
    - Must not conflict with the preferred maintenance window.
    - Must be at least 30 minutes.
    Returns:
    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 Amazon Web Services Region.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Must be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
  - 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.
    
    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Must be in Universal Coordinated Time (UTC).
    - Must not conflict with the preferred maintenance window.
    - Must be at least 30 minutes.
    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 Amazon Web Services Region.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Must be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
    Returns:
    
    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
    
    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
    
    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 Amazon Web Services Region, occurring on a random day of the week.
    
    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
    
    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
    
    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 Amazon Web Services Region, occurring on a random day of the week.
    
    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
    
    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
    
    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 Amazon Web Services Region, occurring on a random day of the week.
    
    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.
  - getTags
```
public List<Tag> getTags()
```
    The tags to be assigned to the cluster.
    
    Returns:
    
    The tags to be assigned to the cluster.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags to be assigned to the cluster.
    
    Parameters:
    
    tags - The tags to be assigned to the cluster.
  - withTags
```
public CreateDBClusterRequest withTags(Tag... tags)
```
    The tags to be assigned to the cluster.
    
    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 - The tags to be assigned to the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateDBClusterRequest withTags(Collection<Tag> tags)
```
    The tags to be assigned to the cluster.
    
    Parameters:
    
    tags - The tags to be assigned to the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageEncrypted
```
public void setStorageEncrypted(Boolean storageEncrypted)
```
    Specifies whether the cluster is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the cluster is encrypted.
  - getStorageEncrypted
```
public Boolean getStorageEncrypted()
```
    Specifies whether the cluster is encrypted.
    
    Returns:
    
    Specifies whether the cluster is encrypted.
  - withStorageEncrypted
```
public CreateDBClusterRequest withStorageEncrypted(Boolean storageEncrypted)
```
    Specifies whether the cluster is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the 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 cluster is encrypted.
    
    Returns:
    
    Specifies whether the cluster is encrypted.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key identifier for an encrypted cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
    Parameters:
    kmsKeyId - The KMS key identifier for an encrypted cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier for an encrypted cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
    Returns:
    The KMS key identifier for an encrypted cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
  - withKmsKeyId
```
public CreateDBClusterRequest withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier for an encrypted cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
    Parameters:
    kmsKeyId - The KMS key identifier for an encrypted cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreSignedUrl
```
public void setPreSignedUrl(String preSignedUrl)
```
    Not currently supported.
    
    Parameters:
    
    preSignedUrl - Not currently supported.
  - getPreSignedUrl
```
public String getPreSignedUrl()
```
    Not currently supported.
    
    Returns:
    
    Not currently supported.
  - withPreSignedUrl
```
public CreateDBClusterRequest withPreSignedUrl(String preSignedUrl)
```
    Not currently supported.
    
    Parameters:
    
    preSignedUrl - Not currently supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnableCloudwatchLogsExports
```
public List<String> getEnableCloudwatchLogsExports()
```
    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
    
    Returns:
    
    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
  - setEnableCloudwatchLogsExports
```
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
```
    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
    
    Parameters:
    
    enableCloudwatchLogsExports - A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
  - withEnableCloudwatchLogsExports
```
public CreateDBClusterRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
```
    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
    
    NOTE: This method appends the values to the existing list (if any). Use setEnableCloudwatchLogsExports(java.util.Collection) or withEnableCloudwatchLogsExports(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    enableCloudwatchLogsExports - A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnableCloudwatchLogsExports
```
public CreateDBClusterRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
```
    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
    
    Parameters:
    
    enableCloudwatchLogsExports - A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletionProtection
```
public void setDeletionProtection(Boolean deletionProtection)
```
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Parameters:
    
    deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  - getDeletionProtection
```
public Boolean getDeletionProtection()
```
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Returns:
    
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  - withDeletionProtection
```
public CreateDBClusterRequest withDeletionProtection(Boolean deletionProtection)
```
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Parameters:
    
    deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDeletionProtection
```
public Boolean isDeletionProtection()
```
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Returns:
    
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  - setGlobalClusterIdentifier
```
public void setGlobalClusterIdentifier(String globalClusterIdentifier)
```
    The cluster identifier of the new global cluster.
    
    Parameters:
    
    globalClusterIdentifier - The cluster identifier of the new global cluster.
  - getGlobalClusterIdentifier
```
public String getGlobalClusterIdentifier()
```
    The cluster identifier of the new global cluster.
    
    Returns:
    
    The cluster identifier of the new global cluster.
  - withGlobalClusterIdentifier
```
public CreateDBClusterRequest withGlobalClusterIdentifier(String globalClusterIdentifier)
```
    The cluster identifier of the new global cluster.
    
    Parameters:
    
    globalClusterIdentifier - The cluster identifier of the new global cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageType
```
public void setStorageType(String storageType)
```
    The storage type to associate with the DB cluster.
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
    
    Parameters:
    
    storageType - The storage type to associate with the DB cluster.
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
  - getStorageType
```
public String getStorageType()
```
    The storage type to associate with the DB cluster.
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
    
    Returns:
    
    The storage type to associate with the DB cluster.
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
  - withStorageType
```
public CreateDBClusterRequest withStorageType(String storageType)
```
    The storage type to associate with the DB cluster.
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
    
    Parameters:
    
    storageType - The storage type to associate with the DB cluster.
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceRegion
```
public void setSourceRegion(String sourceRegion)
```
    The region where the source instance is located.
    
    Parameters:
    
    sourceRegion - The region where the source instance is located.
  - getSourceRegion
```
public String getSourceRegion()
```
    The region where the source instance is located.
    
    Returns:
    
    The region where the source instance is located.
  - withSourceRegion
```
public CreateDBClusterRequest withSourceRegion(String sourceRegion)
```
    The region where the source instance is located.
    
    Parameters:
    
    sourceRegion - The region where the source instance is located.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.773

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

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

setPreferredBackupWindow

getPreferredBackupWindow

withPreferredBackupWindow

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

getTags

setTags

withTags

withTags

setStorageEncrypted

getStorageEncrypted

withStorageEncrypted

isStorageEncrypted

setKmsKeyId

getKmsKeyId

withKmsKeyId

setPreSignedUrl

getPreSignedUrl

withPreSignedUrl

getEnableCloudwatchLogsExports

setEnableCloudwatchLogsExports

withEnableCloudwatchLogsExports

withEnableCloudwatchLogsExports

setDeletionProtection

getDeletionProtection

withDeletionProtection

isDeletionProtection

setGlobalClusterIdentifier

getGlobalClusterIdentifier

withGlobalClusterIdentifier

setStorageType

getStorageType

withStorageType