org.jclouds.rds.domain

Class InstanceRequest

java.lang.Object

org.jclouds.rds.domain.internal.BaseInstance

org.jclouds.rds.domain.InstanceRequest

public class InstanceRequest
extends BaseInstance

Parameters used to create a new Instance

Author:

Adrian Cole

See Also:

doc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceRequest.Builder<T extends InstanceRequest.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoMinorVersionUpgrade
protected int	backupRetentionPeriod
protected com.google.common.base.Optional<String>	characterSet
protected com.google.common.base.Optional<String>	engineVersion
protected com.google.common.base.Optional<String>	licenseModel
protected String	masterPassword
protected com.google.common.base.Optional<String>	optionGroup
protected com.google.common.base.Optional<String>	parameterGroup
protected com.google.common.base.Optional<Integer>	port
protected Set<String>	securityGroups
protected com.google.common.base.Optional<String>	subnetGroup

Fields inherited from class org.jclouds.rds.domain.internal.BaseInstance

allocatedStorageGB, engine, instanceClass, masterUsername, name

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

InstanceRequest(com.google.common.base.Optional<String> name, String instanceClass, com.google.common.base.Optional<Integer> port, com.google.common.base.Optional<String> characterSet, com.google.common.base.Optional<String> optionGroup, com.google.common.base.Optional<String> parameterGroup, boolean autoMinorVersionUpgrade, String engine, com.google.common.base.Optional<String> engineVersion, com.google.common.base.Optional<String> licenseModel, String masterUsername, int allocatedStorageGB, int backupRetentionPeriod, com.google.common.base.Optional<String> subnetGroup, Iterable<String> securityGroups, String masterPassword)

Method Summary

Methods

Modifier and Type	Method and Description
static InstanceRequest.Builder<?>	builder()
int	getBackupRetentionPeriod() The number of days for which automated backups are retained.
com.google.common.base.Optional<String>	getCharacterSet() For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.
com.google.common.base.Optional<String>	getEngineVersion() The version number of the database engine to use.
com.google.common.base.Optional<String>	getLicenseModel() License model information for this DB Instance.
String	getMasterPassword() The password for the master database user.
com.google.common.base.Optional<String>	getOptionGroup() Indicates that the DB Instance should be associated with the specified option group.
com.google.common.base.Optional<String>	getParameterGroup() The name of the DB Parameter Group to associate with this DB instance.
com.google.common.base.Optional<Integer>	getPort() The port number on which the database accepts connections.
Set<String>	getSecurityGroups() A list of DB Security Groups to associate with this DB Instance.
com.google.common.base.Optional<String>	getSubnetGroup() A DB Subnet Group to associate with this DB Instance.
boolean	isAutoMinorVersionUpgrade() Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
protected com.google.common.base.Objects.ToStringHelper	string()
InstanceRequest.Builder<?>	toBuilder()

Methods inherited from class org.jclouds.rds.domain.internal.BaseInstance

equals, getAllocatedStorageGB, getEngine, getInstanceClass, getMasterUsername, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

engineVersion

protected final com.google.common.base.Optional<String> engineVersion

licenseModel

protected final com.google.common.base.Optional<String> licenseModel

port

protected final com.google.common.base.Optional<Integer> port

characterSet

protected final com.google.common.base.Optional<String> characterSet

backupRetentionPeriod

protected final int backupRetentionPeriod

optionGroup

protected final com.google.common.base.Optional<String> optionGroup

parameterGroup

protected final com.google.common.base.Optional<String> parameterGroup

autoMinorVersionUpgrade

protected final boolean autoMinorVersionUpgrade

subnetGroup

protected final com.google.common.base.Optional<String> subnetGroup

securityGroups

protected final Set<String> securityGroups

masterPassword

protected final String masterPassword

Constructor Detail

InstanceRequest

protected InstanceRequest(com.google.common.base.Optional<String> name,
               String instanceClass,
               com.google.common.base.Optional<Integer> port,
               com.google.common.base.Optional<String> characterSet,
               com.google.common.base.Optional<String> optionGroup,
               com.google.common.base.Optional<String> parameterGroup,
               boolean autoMinorVersionUpgrade,
               String engine,
               com.google.common.base.Optional<String> engineVersion,
               com.google.common.base.Optional<String> licenseModel,
               String masterUsername,
               int allocatedStorageGB,
               int backupRetentionPeriod,
               com.google.common.base.Optional<String> subnetGroup,
               Iterable<String> securityGroups,
               String masterPassword)

Method Detail

builder

public static InstanceRequest.Builder<?> builder()

toBuilder

public InstanceRequest.Builder<?> toBuilder()

Overrides:

toBuilder in class BaseInstance

getEngineVersion

public com.google.common.base.Optional<String> getEngineVersion()

The version number of the database engine to use. MySQL Example: 5.1.42 Oracle Example: 11.2.0.2.v2 SQL Server Example: 10.50.2789.0.v1

getLicenseModel

public com.google.common.base.Optional<String> getLicenseModel()

License model information for this DB Instance. Valid values: license-included | bring-your-own-license | general-public-license

getCharacterSet

public com.google.common.base.Optional<String> getCharacterSet()

For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.

getPort

public com.google.common.base.Optional<Integer> getPort()

The port number on which the database accepts connections.

Engine	Default	Range
MySQL	3306	1150-65535
Oracle	1521	1150-65535
SQL Server	1433	1150-65535 except for 1434 and 3389

getBackupRetentionPeriod

public int 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.

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:

value which defaults to 1

getOptionGroup

public com.google.common.base.Optional<String> getOptionGroup()

Indicates that the DB Instance should be associated with the specified option group.

getParameterGroup

public com.google.common.base.Optional<String> getParameterGroup()

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

isAutoMinorVersionUpgrade

public boolean isAutoMinorVersionUpgrade()

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

Returns:

value defaulting to true

getSubnetGroup

public com.google.common.base.Optional<String> getSubnetGroup()

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.

getSecurityGroups

public Set<String> getSecurityGroups()

A list of DB Security Groups to associate with this DB Instance. Default: The default DB Security Group for the database engine.

getMasterPassword

public String getMasterPassword()

The password for the master database user. MySQL Constraints: Must contain from 8 to 41 alphanumeric characters. Oracle Constraints: Must contain from 8 to 30 alphanumeric characters. SQL Server Constraints: Must contain from 8 to 128 alphanumeric characters.

string

protected com.google.common.base.Objects.ToStringHelper string()

Overrides:

string in class BaseInstance