com.amazonaws.services.rds.model
Class CreateDBInstanceRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.rds.model.CreateDBInstanceRequest

public class CreateDBInstanceRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateDBInstance operation.

Creates a new DB instance.

See Also:

AmazonRDS.createDBInstance(CreateDBInstanceRequest)

Constructor Summary

CreateDBInstanceRequest()
Default constructor for a new CreateDBInstanceRequest object.

CreateDBInstanceRequest(String dBInstanceIdentifier, Integer allocatedStorage, String dBInstanceClass, String engine, String masterUsername, String masterUserPassword)
Constructs a new CreateDBInstanceRequest object.

Method Summary

boolean	equals(Object obj)
Integer	getAllocatedStorage() The amount of storage (in gigabytes) to be initially allocated for the database instance.
Boolean	getAutoMinorVersionUpgrade() Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
String	getAvailabilityZone() The EC2 Availability Zone that the database instance will be created in.
Integer	getBackupRetentionPeriod() The number of days for which automated backups are retained.
String	getDBInstanceClass() The compute and memory capacity of the DB Instance.
String	getDBInstanceIdentifier() The DB Instance identifier.
String	getDBName() The meaning of this parameter differs according to the database engine you use.
String	getDBParameterGroupName() The name of the DB Parameter Group to associate with this DB instance.
List<String>	getDBSecurityGroups() A list of DB Security Groups to associate with this DB Instance.
String	getDBSubnetGroupName() A DB Subnet Group to associate with this DB Instance.
String	getEngine() The name of the database engine to be used for this instance.
String	getEngineVersion() The version number of the database engine to use.
String	getLicenseModel() License model information for this DB Instance.
String	getMasterUsername() The name of master user for the client DB Instance.
String	getMasterUserPassword() The password for the master DB Instance user.
Boolean	getMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
Integer	getPort() The port number on which the database accepts 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 (in UTC) during which system maintenance can occur.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
Boolean	isMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
void	setAllocatedStorage(Integer allocatedStorage) The amount of storage (in gigabytes) to be initially allocated for the database instance.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
void	setAvailabilityZone(String availabilityZone) The EC2 Availability Zone that the database instance will be created in.
void	setBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automated backups are retained.
void	setDBInstanceClass(String dBInstanceClass) The compute and memory capacity of the DB Instance.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The DB Instance identifier.
void	setDBName(String dBName) The meaning of this parameter differs according to the database engine you use.
void	setDBParameterGroupName(String dBParameterGroupName) The name of the DB Parameter Group to associate with this DB instance.
void	setDBSecurityGroups(Collection<String> dBSecurityGroups) A list of DB Security Groups to associate with this DB Instance.
void	setDBSubnetGroupName(String dBSubnetGroupName) A DB Subnet Group to associate with this DB Instance.
void	setEngine(String engine) The name of the database engine to be used for this instance.
void	setEngineVersion(String engineVersion) The version number of the database engine to use.
void	setLicenseModel(String licenseModel) License model information for this DB Instance.
void	setMasterUsername(String masterUsername) The name of master user for the client DB Instance.
void	setMasterUserPassword(String masterUserPassword) The password for the master DB Instance user.
void	setMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
void	setPort(Integer port) The port number on which the database accepts 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 (in UTC) during which system maintenance can occur.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDBInstanceRequest	withAllocatedStorage(Integer allocatedStorage) The amount of storage (in gigabytes) to be initially allocated for the database instance.
CreateDBInstanceRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
CreateDBInstanceRequest	withAvailabilityZone(String availabilityZone) The EC2 Availability Zone that the database instance will be created in.
CreateDBInstanceRequest	withBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automated backups are retained.
CreateDBInstanceRequest	withDBInstanceClass(String dBInstanceClass) The compute and memory capacity of the DB Instance.
CreateDBInstanceRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The DB Instance identifier.
CreateDBInstanceRequest	withDBName(String dBName) The meaning of this parameter differs according to the database engine you use.
CreateDBInstanceRequest	withDBParameterGroupName(String dBParameterGroupName) The name of the DB Parameter Group to associate with this DB instance.
CreateDBInstanceRequest	withDBSecurityGroups(Collection<String> dBSecurityGroups) A list of DB Security Groups to associate with this DB Instance.
CreateDBInstanceRequest	withDBSecurityGroups(String... dBSecurityGroups) A list of DB Security Groups to associate with this DB Instance.
CreateDBInstanceRequest	withDBSubnetGroupName(String dBSubnetGroupName) A DB Subnet Group to associate with this DB Instance.
CreateDBInstanceRequest	withEngine(String engine) The name of the database engine to be used for this instance.
CreateDBInstanceRequest	withEngineVersion(String engineVersion) The version number of the database engine to use.
CreateDBInstanceRequest	withLicenseModel(String licenseModel) License model information for this DB Instance.
CreateDBInstanceRequest	withMasterUsername(String masterUsername) The name of master user for the client DB Instance.
CreateDBInstanceRequest	withMasterUserPassword(String masterUserPassword) The password for the master DB Instance user.
CreateDBInstanceRequest	withMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
CreateDBInstanceRequest	withPort(Integer port) The port number on which the database accepts connections.
CreateDBInstanceRequest	withPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
CreateDBInstanceRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDBInstanceRequest

public CreateDBInstanceRequest()

Default constructor for a new CreateDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateDBInstanceRequest

public CreateDBInstanceRequest(String dBInstanceIdentifier,
                               Integer allocatedStorage,
                               String dBInstanceClass,
                               String engine,
                               String masterUsername,
                               String masterUserPassword)

Constructs a new CreateDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

dBInstanceIdentifier - The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

allocatedStorage - The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

dBInstanceClass - The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

masterUsername - The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

masterUserPassword - The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

Method Detail

getDBName

public String getDBName()

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORACL

Constraints:

• Cannot be longer than 8 characters

Returns:

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORACL

Constraints:

• Cannot be longer than 8 characters

setDBName

public void setDBName(String dBName)

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORACL

Constraints:

• Cannot be longer than 8 characters

Parameters:

dBName - The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORACL

Constraints:

• Cannot be longer than 8 characters

withDBName

public CreateDBInstanceRequest withDBName(String dBName)

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORACL

Constraints:

• Cannot be longer than 8 characters

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

Parameters:

dBName - The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORACL

Constraints:

• Cannot be longer than 8 characters

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Returns:

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Parameters:

dBInstanceIdentifier - The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

withDBInstanceIdentifier

public CreateDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

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

Parameters:

dBInstanceIdentifier - The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Returns:

A reference to this updated object so that method calls can be chained together.

getAllocatedStorage

public Integer getAllocatedStorage()

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

Returns:

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

setAllocatedStorage

public void setAllocatedStorage(Integer allocatedStorage)

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

Parameters:

allocatedStorage - The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

withAllocatedStorage

public CreateDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

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

Parameters:

allocatedStorage - The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceClass

public String getDBInstanceClass()

The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Returns:

The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Parameters:

dBInstanceClass - The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

withDBInstanceClass

public CreateDBInstanceRequest withDBInstanceClass(String dBInstanceClass)

The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

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

Parameters:

dBInstanceClass - The compute and memory capacity of the DB Instance.

Valid Values: db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Returns:

A reference to this updated object so that method calls can be chained together.

getEngine

public String getEngine()

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

Returns:

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

setEngine

public void setEngine(String engine)

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

Parameters:

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

withEngine

public CreateDBInstanceRequest withEngine(String engine)

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

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

Parameters:

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee

Returns:

A reference to this updated object so that method calls can be chained together.

getMasterUsername

public String getMasterUsername()

The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Returns:

The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

setMasterUsername

public void setMasterUsername(String masterUsername)

The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Parameters:

masterUsername - The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

withMasterUsername

public CreateDBInstanceRequest withMasterUsername(String masterUsername)

The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

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

Parameters:

masterUsername - The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Returns:

A reference to this updated object so that method calls can be chained together.

getMasterUserPassword

public String getMasterUserPassword()

The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

Returns:

The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

setMasterUserPassword

public void setMasterUserPassword(String masterUserPassword)

The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

Parameters:

masterUserPassword - The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

withMasterUserPassword

public CreateDBInstanceRequest withMasterUserPassword(String masterUserPassword)

The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

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

Parameters:

masterUserPassword - The password for the master DB Instance user.

MySQL

Constraints: Cannot contain more than 41 alphanumeric characters.

Type: String

Oracle

Constraints: Cannot contain more than 30 alphanumeric characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBSecurityGroups

public List<String> getDBSecurityGroups()

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

Returns:

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

setDBSecurityGroups

public void setDBSecurityGroups(Collection<String> dBSecurityGroups)

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

Parameters:

dBSecurityGroups - A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

withDBSecurityGroups

public CreateDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

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

Parameters:

dBSecurityGroups - A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

Returns:

A reference to this updated object so that method calls can be chained together.

withDBSecurityGroups

public CreateDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

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

Parameters:

dBSecurityGroups - A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

public String getAvailabilityZone()

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

Returns:

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

Parameters:

availabilityZone - The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

withAvailabilityZone

public CreateDBInstanceRequest withAvailabilityZone(String availabilityZone)

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

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

Parameters:

availabilityZone - The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBSubnetGroupName

public String getDBSubnetGroupName()

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

Returns:

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

setDBSubnetGroupName

public void setDBSubnetGroupName(String dBSubnetGroupName)

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

Parameters:

dBSubnetGroupName - A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

withDBSubnetGroupName

public CreateDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName)

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

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

Parameters:

dBSubnetGroupName - A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

The weekly time range (in UTC) during which system maintenance can occur.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

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

Constraints: Minimum 30-minute window.

Returns:

The weekly time range (in UTC) during which system maintenance can occur.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

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

Constraints: Minimum 30-minute window.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range (in UTC) during which system maintenance can occur.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

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

Constraints: Minimum 30-minute window.

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

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

Constraints: Minimum 30-minute window.

withPreferredMaintenanceWindow

public CreateDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range (in UTC) during which system maintenance can occur.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

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

Constraints: Minimum 30-minute window.

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

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

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

Constraints: Minimum 30-minute window.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBParameterGroupName

public String getDBParameterGroupName()

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

setDBParameterGroupName

public void setDBParameterGroupName(String dBParameterGroupName)

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

dBParameterGroupName - The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

withDBParameterGroupName

public CreateDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

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

Parameters:

dBParameterGroupName - The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

A reference to this updated object so that method calls can be chained together.

getBackupRetentionPeriod

public Integer getBackupRetentionPeriod()

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

Returns:

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

setBackupRetentionPeriod

public void setBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

Parameters:

backupRetentionPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

withBackupRetentionPeriod

public CreateDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

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

Parameters:

backupRetentionPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredBackupWindow

public String getPreferredBackupWindow()

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

Returns:

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

setPreferredBackupWindow

public void setPreferredBackupWindow(String preferredBackupWindow)

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

Parameters:

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

withPreferredBackupWindow

public CreateDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

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

Parameters:

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

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

Returns:

A reference to this updated object so that method calls can be chained together.

getPort

public Integer getPort()

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

Returns:

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

setPort

public void setPort(Integer port)

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

Parameters:

port - The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

withPort

public CreateDBInstanceRequest withPort(Integer port)

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

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

Parameters:

port - The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

Returns:

A reference to this updated object so that method calls can be chained together.

isMultiAZ

public Boolean isMultiAZ()

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Returns:

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

setMultiAZ

public void setMultiAZ(Boolean multiAZ)

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Parameters:

multiAZ - Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

withMultiAZ

public CreateDBInstanceRequest withMultiAZ(Boolean multiAZ)

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

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

Parameters:

multiAZ - Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Returns:

A reference to this updated object so that method calls can be chained together.

getMultiAZ

public Boolean getMultiAZ()

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Returns:

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

getEngineVersion

public String getEngineVersion()

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Returns:

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

setEngineVersion

public void setEngineVersion(String engineVersion)

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Parameters:

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

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

withEngineVersion

public CreateDBInstanceRequest withEngineVersion(String engineVersion)

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

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

Parameters:

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

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Returns:

A reference to this updated object so that method calls can be chained together.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

Returns:

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

withAutoMinorVersionUpgrade

public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

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

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

Returns:

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

getLicenseModel

public String getLicenseModel()

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

Returns:

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

setLicenseModel

public void setLicenseModel(String licenseModel)

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

Parameters:

licenseModel - License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

withLicenseModel

public CreateDBInstanceRequest withLicenseModel(String licenseModel)

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

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

Parameters:

licenseModel - License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object