org.jclouds.rds.domain

Class Instance

java.lang.Object

org.jclouds.rds.domain.internal.BaseInstance

org.jclouds.rds.domain.Instance

public class Instance
extends BaseInstance

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

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.base.Optional<String>	availabilityZone
protected com.google.common.base.Optional<Date>	createdTime
protected com.google.common.base.Optional<com.google.common.net.HostAndPort>	endpoint
protected String	engineVersion
protected String	id
protected String	licenseModel
protected boolean	multiAZ
protected String	rawStatus
protected Map<String,String>	securityGroupNameToStatus
protected Instance.Status	status
protected com.google.common.base.Optional<SubnetGroup>	subnetGroup

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

allocatedStorageGB, engine, instanceClass, masterUsername, name

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

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

Method Summary

Methods

Modifier and Type	Method and Description
static Instance.Builder<?>	builder()
boolean	equals(Object obj)
com.google.common.base.Optional<String>	getAvailabilityZone() Specifies the name of the Availability Zone the DB Instance is located in, or absent if the database is in creating state
com.google.common.base.Optional<Date>	getCreatedTime() Provides the date and time the DB Instance was created, or absent if the database is in creating state
com.google.common.base.Optional<com.google.common.net.HostAndPort>	getEndpoint() Specifies the connection endpoint, or absent if the database is in Instance.Status.CREATING or Instance.Status.DELETING states
String	getEngineVersion() Indicates the database engine version.
String	getId() Contains a user-supplied database identifier.
String	getLicenseModel() License model information for this DB Instance.
String	getRawStatus() Specifies the current state of this database unparsed.
Map<String,String>	getSecurityGroupNameToStatus() SecurityGroupName -> Status
Instance.Status	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 org.jclouds.rds.domain.internal.BaseInstance

getAllocatedStorageGB, getEngine, getInstanceClass, getMasterUsername, getName, string

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final String id

endpoint

protected final com.google.common.base.Optional<com.google.common.net.HostAndPort> endpoint

rawStatus

protected final String rawStatus

status

protected final Instance.Status status

createdTime

protected final com.google.common.base.Optional<Date> createdTime

engineVersion

protected final String engineVersion

licenseModel

protected final String licenseModel

availabilityZone

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

multiAZ

protected final boolean multiAZ

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.base.Optional<com.google.common.net.HostAndPort> endpoint,
        String rawStatus,
        Instance.Status status,
        com.google.common.base.Optional<String> availabilityZone,
        boolean multiAZ,
        String engine,
        String engineVersion,
        String licenseModel,
        String masterUsername,
        int allocatedStorageGB,
        com.google.common.base.Optional<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()

Overrides:

toBuilder in class BaseInstance

getId

public String getId()

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

getStatus

public Instance.Status getStatus()

Specifies the current state of this database.

getRawStatus

public String getRawStatus()

Specifies the current state of this database unparsed.

getEndpoint

public com.google.common.base.Optional<com.google.common.net.HostAndPort> getEndpoint()

Specifies the connection endpoint, or absent if the database is in Instance.Status.CREATING or Instance.Status.DELETING states

getCreatedTime

public com.google.common.base.Optional<Date> getCreatedTime()

Provides the date and time the DB Instance was created, or absent if the database is in creating state

getEngineVersion

public String getEngineVersion()

Indicates the database engine version.

getLicenseModel

public String getLicenseModel()

License model information for this DB Instance.

getAvailabilityZone

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

Specifies the name of the Availability Zone the DB Instance is located in, or absent if the database is in creating state

isMultiAZ

public boolean isMultiAZ()

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

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

Description copied from class: BaseInstance

Overrides:

hashCode in class BaseInstance

equals

public boolean equals(Object obj)

Description copied from class: BaseInstance

Overrides:

equals in class BaseInstance

toString

public String toString()

Overrides:

toString in class BaseInstance