org.jclouds.rds.features
Interface InstanceApi

public interface InstanceApi

Provides access to Amazon RDS via the Query API

Author:

Adrian Cole

See Also:

doc, InstanceAsyncApi

Method Summary

void	delete(String id) Deletes the specified Instance.
Instance	get(String id) Retrieves information about the specified instance.
PagedIterable<Instance>	list() Returns information about provisioned RDS instances.
IterableWithMarker<Instance>	list(ListInstancesOptions options) Returns information about provisioned RDS instances.

Method Detail

get

@Nullable
Instance get(String id)

Retrieves information about the specified instance.

Parameters:

id - The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn't case sensitive.

Returns:

null if not found

list

IterableWithMarker<Instance> list(ListInstancesOptions options)

Returns information about provisioned RDS instances. If there are none, the action returns an empty list.
You can paginate the results using the parameter

Parameters:

options - the options describing the instances query

Returns:

the response object

list

PagedIterable<Instance> list()

Returns information about provisioned RDS instances.

Returns:

the response object

delete

void delete(String id)

Deletes the specified Instance.

The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be "deleting" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.

Parameters:

id - The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive.