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

Methods

Modifier and Type	Method and Description
Instance	create(String id, InstanceRequest instanceRequest) Creates a new DB instance in a random, system-chosen Availability Zone in the endpoint's region.
Instance	createInAvailabilityZone(String id, InstanceRequest instanceRequest, String availabilityZone) Creates a new DB instance in the specified availabilityZone
Instance	createMultiAZ(String id, InstanceRequest instanceRequest) Creates a Multi-AZ deployment.
Instance	delete(String id) Deletes the specified Instance, skipping final snapshot.
Instance	deleteAndSaveSnapshot(String id, String snapshotId) 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

create

Instance create(String id,
              InstanceRequest instanceRequest)

Creates a new DB instance in a random, system-chosen Availability Zone in the endpoint's region.

Parameters:

id - unique id of the new instance

instanceRequest - parameters to create the instance with

Returns:

new instance being created

createInAvailabilityZone

Instance createInAvailabilityZone(String id,
                                InstanceRequest instanceRequest,
                                String availabilityZone)

Creates a new DB instance in the specified availabilityZone

Parameters:

id - unique id of the new instance

instanceRequest - parameters to create the instance with

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

Returns:

new instance being created

createMultiAZ

Instance createMultiAZ(String id,
                     InstanceRequest instanceRequest)

Creates a Multi-AZ deployment. This is not compatible with Microsoft SQL Server.

Parameters:

id - unique id of the new instance

instanceRequest - parameters to create the instance with

Returns:

new instance being created

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

Instance delete(String id)

Deletes the specified Instance, skipping final snapshot.

The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. 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.

Returns:

final state of instance or null if not found

deleteAndSaveSnapshot

Instance deleteAndSaveSnapshot(String id,
                             String snapshotId)

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

snapshotId - The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Returns:

final state of instance or null if not found