com.amazonaws.services.docdb.model

Class CreateDBClusterRequest

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()

Method Summary

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 DB cluster can be created in.
Integer	getBackupRetentionPeriod() The number of days for which automated backups are retained.
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.
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 DB cluster.
String	getEngineVersion() The version number of the database engine to use.
String	getKmsKeyId() The AWS 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.
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).
Boolean	getStorageEncrypted() Specifies whether the DB cluster is encrypted.
List<Tag>	getTags() The tags to be assigned to the DB cluster.
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 Amazon 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	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	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 DB cluster.
void	setEngineVersion(String engineVersion) The version number of the database engine to use.
void	setKmsKeyId(String kmsKeyId) The AWS 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	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	setStorageEncrypted(Boolean storageEncrypted) Specifies whether the DB cluster is encrypted.
void	setTags(Collection<Tag> tags) The tags to be assigned to the DB cluster.
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.
CreateDBClusterRequest	withAvailabilityZones(Collection<String> availabilityZones) A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.
CreateDBClusterRequest	withAvailabilityZones(String... availabilityZones) A list of Amazon 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	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	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 DB cluster.
CreateDBClusterRequest	withEngineVersion(String engineVersion) The version number of the database engine to use.
CreateDBClusterRequest	withKmsKeyId(String kmsKeyId) The AWS 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	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	withStorageEncrypted(Boolean storageEncrypted) Specifies whether the DB cluster is encrypted.
CreateDBClusterRequest	withTags(Collection<Tag> tags) The tags to be assigned to the DB cluster.
CreateDBClusterRequest	withTags(Tag... tags) The tags to be assigned to the DB cluster.
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 com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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 DB cluster can be created in.

Returns:

A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.

setAvailabilityZones

public void setAvailabilityZones(Collection<String> availabilityZones)

A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.

Parameters:

availabilityZones - A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.

withAvailabilityZones

public CreateDBClusterRequest withAvailabilityZones(String... availabilityZones)

A list of Amazon EC2 Availability Zones that instances in the DB 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 DB 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 DB cluster can be created in.

Parameters:

availabilityZones - A list of Amazon EC2 Availability Zones that instances in the DB 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 DB 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 DB 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 DB 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 DB 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 DB 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 DB 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 DB cluster parameter group to associate with this DB cluster.

Parameters:

dBClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster.

getDBClusterParameterGroupName

public String getDBClusterParameterGroupName()

The name of the DB cluster parameter group to associate with this DB cluster.

Returns:

The name of the DB cluster parameter group to associate with this DB cluster.

withDBClusterParameterGroupName

public CreateDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster parameter group to associate with this DB cluster.

Parameters:

dBClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB 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 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 match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Parameters:

dBSubnetGroupName - A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

getDBSubnetGroupName

public String getDBSubnetGroupName()

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Returns:

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

withDBSubnetGroupName

public CreateDBClusterRequest withDBSubnetGroupName(String dBSubnetGroupName)

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Parameters:

dBSubnetGroupName - A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Returns:

Returns a reference to this object so that method calls can be chained together.

setEngine

public void setEngine(String engine)

The name of the database engine to be used for this DB cluster.

Valid values: docdb

Parameters:

engine - The name of the database engine to be used for this DB cluster.

Valid values: docdb

getEngine

public String getEngine()

The name of the database engine to be used for this DB cluster.

Valid values: docdb

Returns:

The name of the database engine to be used for this DB cluster.

Valid values: docdb

withEngine

public CreateDBClusterRequest withEngine(String engine)

The name of the database engine to be used for this DB cluster.

Valid values: docdb

Parameters:

engine - The name of the database engine to be used for this DB 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.

Parameters:

engineVersion - The version number of the database engine to use.

getEngineVersion

public String getEngineVersion()

The version number of the database engine to use.

Returns:

The version number of the database engine to use.

withEngineVersion

public CreateDBClusterRequest withEngineVersion(String engineVersion)

The version number of the database engine to use.

Parameters:

engineVersion - The version number of the database engine to use.

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.

Parameters:

port - The port number on which the instances in the DB cluster accept connections.

getPort

public Integer getPort()

The port number on which the instances in the DB cluster accept connections.

Returns:

The port number on which the instances in the DB cluster accept connections.

withPort

public CreateDBClusterRequest withPort(Integer port)

The port number on which the instances in the DB cluster accept connections.

Parameters:

port - The port number on which the instances in the DB 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 DB cluster.

Constraints:

• Must be from 1 to 16 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 DB cluster.

Constraints:

• Must be from 1 to 16 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 DB cluster.

Constraints:

• Must be from 1 to 16 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 DB cluster.

Constraints:

• Must be from 1 to 16 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 DB cluster.

Constraints:

• Must be from 1 to 16 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 DB cluster.

Constraints:

• Must be from 1 to 16 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 "/", """, 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.

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 AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

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 AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Returns:

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

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 AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Returns:

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 AWS 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 AWS 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 AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

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 AWS 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 AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

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 DB cluster.

Returns:

The tags to be assigned to the DB cluster.

setTags

public void setTags(Collection<Tag> tags)

The tags to be assigned to the DB cluster.

Parameters:

tags - The tags to be assigned to the DB cluster.

withTags

public CreateDBClusterRequest withTags(Tag... tags)

The tags to be assigned to the DB 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 DB 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 DB cluster.

Parameters:

tags - The tags to be assigned to the DB 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 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 AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

Parameters:

kmsKeyId - The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

getKmsKeyId

public String getKmsKeyId()

The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

Returns:

The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

withKmsKeyId

public CreateDBClusterRequest withKmsKeyId(String kmsKeyId)

The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

Parameters:

kmsKeyId - The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

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.

Returns:

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

setEnableCloudwatchLogsExports

public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

Parameters:

enableCloudwatchLogsExports - A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

withEnableCloudwatchLogsExports

public CreateDBClusterRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

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.

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.

Parameters:

enableCloudwatchLogsExports - A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

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()