org.jclouds.rds.domain
Class Instance

java.lang.Object
  org.jclouds.rds.domain.Instance

public class Instance
extends Object

A DB Instance is an isolated database environment running in the cloud. A DB Instance can contain multiple user-created databases, and can be accessed using the same tools and applications as a stand-alone database instance.

Note

Amazon RDS supports access from any standard SQL api application. Amazon RDS does not allow direct host access via Telnet, Secure Shell (SSH), or Windows Remote Desktop Connection. DB Instances are simple to create and modify with the Amazon RDS command line tools, APIs, or the AWS Management Console. Amazon RDS creates a master user account for your DB Instance as part of the creation process. This master user has permissions to create databases and to perform create, delete, select, update and insert operations on tables the master user creates. You must set the master user password when you create a DB Instance, but you can change it at any time using the Amazon RDS command line tools, APIs, or the AWS Management Console. You can also change the master user password and manage users using standard SQL commands.

Author:

Adrian Cole

See Also:

doc

Nested Class Summary

static class

Instance.Builder<T extends Instance.Builder<T>>

Field Summary

protected int	allocatedStorageGB
protected String	availabilityZone
protected Date	createdTime
protected com.google.common.net.HostAndPort	endpoint
protected String	engine
protected String	engineVersion
protected String	id
protected String	instanceClass
protected String	licenseModel
protected String	masterUsername
protected boolean	multiAZ
protected com.google.common.base.Optional<String>	name
protected Map<String,String>	securityGroupNameToStatus
protected String	status
protected com.google.common.base.Optional<SubnetGroup>	subnetGroup

Constructor Summary

protected

Instance(String id, com.google.common.base.Optional<String> name, String instanceClass, com.google.common.net.HostAndPort endpoint, String status, String availabilityZone, boolean multiAZ, String engine, String engineVersion, String licenseModel, String masterUsername, int allocatedStorageGB, Date createdTime, com.google.common.base.Optional<SubnetGroup> subnetGroup, Map<String,String> securityGroupNameToStatus)

Method Summary

static Instance.Builder<?>	builder()
boolean	equals(Object obj)
int	getAllocatedStorageGB() Specifies the allocated storage size specified in gigabytes.
String	getAvailabilityZone() Specifies the name of the Availability Zone the DB Instance is located in.
Date	getCreatedTime() Provides the date and time the DB Instance was created.
com.google.common.net.HostAndPort	getEndpoint() Specifies the connection endpoint.
String	getEngine() Provides the name of the database engine to be used for this DB Instance.
String	getEngineVersion() Indicates the database engine version.
String	getId() Contains a user-supplied database identifier.
String	getInstanceClass() Contains the name of the compute and memory capacity class of the DB Instance.
String	getLicenseModel() License model information for this DB Instance.
String	getMasterUsername() Contains the master username for the DB Instance.
com.google.common.base.Optional<String>	getName() The meaning of this parameter differs according to the database engine you use.
Map<String,String>	getSecurityGroupNameToStatus() SecurityGroupName -> Status
String	getStatus() Specifies the current state of this database.
com.google.common.base.Optional<SubnetGroup>	getSubnetGroup() Provides the information of the subnet group associated with the DB instance, including the name, description and subnets in the subnet group.
int	hashCode()
boolean	isMultiAZ() Specifies the name of the Availability Zone the DB Instance is located in.
Instance.Builder<?>	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final String id

name

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

instanceClass

protected final String instanceClass

endpoint

protected final com.google.common.net.HostAndPort endpoint

status

protected final String status

availabilityZone

protected final String availabilityZone

multiAZ

protected final boolean multiAZ

engine

protected final String engine

engineVersion

protected final String engineVersion

licenseModel

protected final String licenseModel

masterUsername

protected final String masterUsername

allocatedStorageGB

protected int allocatedStorageGB

createdTime

protected final Date createdTime

subnetGroup

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

securityGroupNameToStatus

protected final Map<String,String> securityGroupNameToStatus

Constructor Detail

Instance

protected Instance(String id,
                   com.google.common.base.Optional<String> name,
                   String instanceClass,
                   com.google.common.net.HostAndPort endpoint,
                   String status,
                   String availabilityZone,
                   boolean multiAZ,
                   String engine,
                   String engineVersion,
                   String licenseModel,
                   String masterUsername,
                   int allocatedStorageGB,
                   Date createdTime,
                   com.google.common.base.Optional<SubnetGroup> subnetGroup,
                   Map<String,String> securityGroupNameToStatus)

Method Detail

builder

public static Instance.Builder<?> builder()

toBuilder

public Instance.Builder<?> toBuilder()

getId

public String getId()

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

getName

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

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

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Oracle

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

getStatus

public String getStatus()

Specifies the current state of this database.

getInstanceClass

public String getInstanceClass()

Contains the name of the compute and memory capacity class of the DB Instance.

getEndpoint

public com.google.common.net.HostAndPort getEndpoint()

Specifies the connection endpoint.

getAvailabilityZone

public String getAvailabilityZone()

Specifies the name of the Availability Zone the DB Instance is located in.

isMultiAZ

public boolean isMultiAZ()

Specifies the name of the Availability Zone the DB Instance is located in.

getEngine

public String getEngine()

Provides the name of the database engine to be used for this DB Instance.

getEngineVersion

public String getEngineVersion()

Indicates the database engine version.

getLicenseModel

public String getLicenseModel()

License model information for this DB Instance.

getMasterUsername

public String getMasterUsername()

Contains the master username for the DB Instance.

getAllocatedStorageGB

public int getAllocatedStorageGB()

Specifies the allocated storage size specified in gigabytes.

getCreatedTime

public Date getCreatedTime()

Provides the date and time the DB Instance was created.

getSubnetGroup

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

Provides the information of the subnet group associated with the DB instance, including the name, description and subnets in the subnet group.

getSecurityGroupNameToStatus

public Map<String,String> getSecurityGroupNameToStatus()

SecurityGroupName -> Status

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object