com.amazonaws.services.rds
Interface AmazonRDS

All Known Subinterfaces:

AmazonRDSAsync

All Known Implementing Classes:

AmazonRDSAsyncClient, AmazonRDSClient

public interface AmazonRDS

Interface for accessing AmazonRDS. Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is the Amazon RDS API Reference . It contains a comprehensive description of all Amazon RDS Query APIs and data types. To get started with Amazon RDS, go to the Amazon RDS Getting Started Guide . For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDS User Guide .

Method Summary

DBSecurityGroup	authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization.
DBSnapshot	copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest) Copies the specified DBSnapshot.
DBInstance	createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) Creates a new DB instance.
DBInstance	createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) Creates a DB Instance that acts as a Read Replica of a source DB Instance.
DBParameterGroup	createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest) Creates a new DB Parameter Group.
DBSecurityGroup	createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) Creates a new DB Security Group.
DBSnapshot	createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest) Creates a DBSnapshot.
DBSubnetGroup	createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) Creates a new DB subnet group.
DBInstance	deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) The DeleteDBInstance API deletes a previously provisioned RDS instance.
void	deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) Deletes a specified DBParameterGroup.
void	deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) Deletes a DB Security Group.
DBSnapshot	deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest) Deletes a DBSnapshot.
void	deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a DB subnet group.
DescribeDBEngineVersionsResult	describeDBEngineVersions() Returns a list of the available DB engines.
DescribeDBEngineVersionsResult	describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available DB engines.
DescribeDBInstancesResult	describeDBInstances() Returns information about provisioned RDS instances.
DescribeDBInstancesResult	describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) Returns information about provisioned RDS instances.
DescribeDBParameterGroupsResult	describeDBParameterGroups() Returns a list of DBParameterGroup descriptions.
DescribeDBParameterGroupsResult	describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) Returns a list of DBParameterGroup descriptions.
DescribeDBParametersResult	describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest) Returns the detailed parameter list for a particular DBParameterGroup.
DescribeDBSecurityGroupsResult	describeDBSecurityGroups() Returns a list of DBSecurityGroup descriptions.
DescribeDBSecurityGroupsResult	describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) Returns a list of DBSecurityGroup descriptions.
DescribeDBSnapshotsResult	describeDBSnapshots() Returns information about DBSnapshots.
DescribeDBSnapshotsResult	describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) Returns information about DBSnapshots.
DescribeDBSubnetGroupsResult	describeDBSubnetGroups() Returns a list of DBSubnetGroup descriptions.
DescribeDBSubnetGroupsResult	describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.
EngineDefaults	describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
DescribeEventsResult	describeEvents() Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days.
DescribeOrderableDBInstanceOptionsResult	describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable DB Instance options for the specified engine.
DescribeReservedDBInstancesResult	describeReservedDBInstances() Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
DescribeReservedDBInstancesResult	describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
DescribeReservedDBInstancesOfferingsResult	describeReservedDBInstancesOfferings() Lists available reserved DB Instance offerings.
DescribeReservedDBInstancesOfferingsResult	describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) Lists available reserved DB Instance offerings.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
DBInstance	modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest) Modify settings for a DB Instance.
ModifyDBParameterGroupResult	modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) Modifies the parameters of a DBParameterGroup.
DBSubnetGroup	modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) Modifies an existing DB subnet group.
ReservedDBInstance	purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) Purchases a reserved DB Instance offering.
DBInstance	rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) Reboots a previously provisioned RDS instance.
ResetDBParameterGroupResult	resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) Modifies the parameters of a DBParameterGroup to the engine/system default value.
DBInstance	restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) Creates a new DB Instance from a DB snapshot.
DBInstance	restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) Restores a DB Instance to an arbitrary point-in-time.
DBSecurityGroup	revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://rds.amazonaws.com").
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://rds.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

deleteDBInstance

DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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:

deleteDBInstanceRequest - Container for the necessary parameters to execute the DeleteDBInstance service method on AmazonRDS.

Returns:

The response from the DeleteDBInstance service method, as returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

SnapshotQuotaExceededException

DBSnapshotAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSubnetGroups

DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial .

Parameters:

describeDBSubnetGroupsRequest - Container for the necessary parameters to execute the DescribeDBSubnetGroups service method on AmazonRDS.

Returns:

The response from the DescribeDBSubnetGroups service method, as returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

modifyDBParameterGroup

ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

NOTE: The apply-immediate method can only be used for dynamic parameters; the pending-reboot method can be used for either dynamic or static parameters.

Parameters:

modifyDBParameterGroupRequest - Container for the necessary parameters to execute the ModifyDBParameterGroup service method on AmazonRDS.

Returns:

The response from the ModifyDBParameterGroup service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

modifyDBInstance

DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Parameters:

modifyDBInstanceRequest - Container for the necessary parameters to execute the ModifyDBInstance service method on AmazonRDS.

Returns:

The response from the ModifyDBInstance service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

DBInstanceNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBInstanceStateException

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

InsufficientDBInstanceCapacityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeReservedDBInstances

DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

Parameters:

describeReservedDBInstancesRequest - Container for the necessary parameters to execute the DescribeReservedDBInstances service method on AmazonRDS.

Returns:

The response from the DescribeReservedDBInstances service method, as returned by AmazonRDS.

Throws:

ReservedDBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBSubnetGroup

void deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Deletes a DB subnet group.

NOTE:The specified database subnet group must not be associated with any DB instances.

Parameters:

deleteDBSubnetGroupRequest - Container for the necessary parameters to execute the DeleteDBSubnetGroup service method on AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

InvalidDBSubnetGroupStateException

InvalidDBSubnetStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBSubnetGroup

DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region.

Parameters:

createDBSubnetGroupRequest - Container for the necessary parameters to execute the CreateDBSubnetGroup service method on AmazonRDS.

Returns:

The response from the CreateDBSubnetGroup service method, as returned by AmazonRDS.

Throws:

DBSubnetQuotaExceededException

DBSubnetGroupAlreadyExistsException

DBSubnetGroupQuotaExceededException

DBSubnetGroupListDoesNotCoverAllAzException

InvalidSubnetException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSecurityGroups

DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial .

Parameters:

describeDBSecurityGroupsRequest - Container for the necessary parameters to execute the DescribeDBSecurityGroups service method on AmazonRDS.

Returns:

The response from the DescribeDBSecurityGroups service method, as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

purchaseReservedDBInstancesOffering

ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Purchases a reserved DB Instance offering.

Parameters:

purchaseReservedDBInstancesOfferingRequest - Container for the necessary parameters to execute the PurchaseReservedDBInstancesOffering service method on AmazonRDS.

Returns:

The response from the PurchaseReservedDBInstancesOffering service method, as returned by AmazonRDS.

Throws:

ReservedDBInstancesOfferingNotFoundException

ReservedDBInstanceQuotaExceededException

ReservedDBInstanceAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBSecurityGroup

void deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

Deletes a DB Security Group.

NOTE:The specified DB Security Group must not be associated with any DB Instances.

Parameters:

deleteDBSecurityGroupRequest - Container for the necessary parameters to execute the DeleteDBSecurityGroup service method on AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

modifyDBSubnetGroup

DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region.

Parameters:

modifyDBSubnetGroupRequest - Container for the necessary parameters to execute the ModifyDBSubnetGroup service method on AmazonRDS.

Returns:

The response from the ModifyDBSubnetGroup service method, as returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

DBSubnetQuotaExceededException

SubnetAlreadyInUseException

DBSubnetGroupListDoesNotCoverAllAzException

InvalidSubnetException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBSnapshot

DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a DBSnapshot. The source DBInstance must be in "available" state.

Parameters:

createDBSnapshotRequest - Container for the necessary parameters to execute the CreateDBSnapshot service method on AmazonRDS.

Returns:

The response from the CreateDBSnapshot service method, as returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

SnapshotQuotaExceededException

DBSnapshotAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns a list of the available DB engines.

Parameters:

describeDBEngineVersionsRequest - Container for the necessary parameters to execute the DescribeDBEngineVersions service method on AmazonRDS.

Returns:

The response from the DescribeDBEngineVersions service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

restoreDBInstanceToPointInTime

DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

Parameters:

restoreDBInstanceToPointInTimeRequest - Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime service method on AmazonRDS.

Returns:

The response from the RestoreDBInstanceToPointInTime service method, as returned by AmazonRDS.

Throws:

PointInTimeRestoreNotEnabledException

InvalidRestoreException

InstanceQuotaExceededException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

DBInstanceNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBInstanceStateException

InsufficientDBInstanceCapacityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

copyDBSnapshot

DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.

Parameters:

copyDBSnapshotRequest - Container for the necessary parameters to execute the CopyDBSnapshot service method on AmazonRDS.

Returns:

The response from the CopyDBSnapshot service method, as returned by AmazonRDS.

Throws:

InvalidDBSnapshotStateException

SnapshotQuotaExceededException

DBSnapshotAlreadyExistsException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

resetDBParameterGroup

ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

Parameters:

resetDBParameterGroupRequest - Container for the necessary parameters to execute the ResetDBParameterGroup service method on AmazonRDS.

Returns:

The response from the ResetDBParameterGroup service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeOrderableDBInstanceOptions

DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

Returns a list of orderable DB Instance options for the specified engine.

Parameters:

describeOrderableDBInstanceOptionsRequest - Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method on AmazonRDS.

Returns:

The response from the DescribeOrderableDBInstanceOptions service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBSnapshot

DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a DBSnapshot.

NOTE:The DBSnapshot must be in the available state to be deleted.

Parameters:

deleteDBSnapshotRequest - Container for the necessary parameters to execute the DeleteDBSnapshot service method on AmazonRDS.

Returns:

The response from the DeleteDBSnapshot service method, as returned by AmazonRDS.

Throws:

InvalidDBSnapshotStateException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBParameters

DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the detailed parameter list for a particular DBParameterGroup.

Parameters:

describeDBParametersRequest - Container for the necessary parameters to execute the DescribeDBParameters service method on AmazonRDS.

Returns:

The response from the DescribeDBParameters service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBInstance

DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a new DB instance.

Parameters:

createDBInstanceRequest - Container for the necessary parameters to execute the CreateDBInstance service method on AmazonRDS.

Returns:

The response from the CreateDBInstance service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InstanceQuotaExceededException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

StorageQuotaExceededException

InvalidVPCNetworkStateException

DBSecurityGroupNotFoundException

InsufficientDBInstanceCapacityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBParameterGroup

void deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.

NOTE: The specified DB Parameter Group cannot be associated with any DB Instances.

Parameters:

deleteDBParameterGroupRequest - Container for the necessary parameters to execute the DeleteDBParameterGroup service method on AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

revokeDBSecurityGroupIngress

DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

Parameters:

revokeDBSecurityGroupIngressRequest - Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress service method on AmazonRDS.

Returns:

The response from the RevokeDBSecurityGroupIngress service method, as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

AuthorizationNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBSecurityGroup

DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Creates a new DB Security Group. DB Security Groups control access to a DB Instance.

Parameters:

createDBSecurityGroupRequest - Container for the necessary parameters to execute the CreateDBSecurityGroup service method on AmazonRDS.

Returns:

The response from the CreateDBSecurityGroup service method, as returned by AmazonRDS.

Throws:

DBSecurityGroupQuotaExceededException

DBSecurityGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBParameterGroups

DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.

Parameters:

describeDBParameterGroupsRequest - Container for the necessary parameters to execute the DescribeDBParameterGroups service method on AmazonRDS.

Returns:

The response from the DescribeDBParameterGroups service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeEvents

DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events specific to a particular DB Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Parameters:

describeEventsRequest - Container for the necessary parameters to execute the DescribeEvents service method on AmazonRDS.

Returns:

The response from the DescribeEvents service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeEngineDefaultParameters

EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Returns the default engine and system parameter information for the specified database engine.

Parameters:

describeEngineDefaultParametersRequest - Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method on AmazonRDS.

Returns:

The response from the DescribeEngineDefaultParameters service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBParameterGroup

DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates a new DB Parameter Group.

A DB Parameter Group is initially created with the default parameters for the database engine used by the DB Instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup . Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance . When you associate a new DB Parameter Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Group and associated settings to take effect.

Parameters:

createDBParameterGroupRequest - Container for the necessary parameters to execute the CreateDBParameterGroup service method on AmazonRDS.

Returns:

The response from the CreateDBParameterGroup service method, as returned by AmazonRDS.

Throws:

DBParameterGroupQuotaExceededException

DBParameterGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeReservedDBInstancesOfferings

DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Lists available reserved DB Instance offerings.

Parameters:

describeReservedDBInstancesOfferingsRequest - Container for the necessary parameters to execute the DescribeReservedDBInstancesOfferings service method on AmazonRDS.

Returns:

The response from the DescribeReservedDBInstancesOfferings service method, as returned by AmazonRDS.

Throws:

ReservedDBInstancesOfferingNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBInstances

DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about provisioned RDS instances. This API supports pagination.

Parameters:

describeDBInstancesRequest - Container for the necessary parameters to execute the DescribeDBInstances service method on AmazonRDS.

Returns:

The response from the DescribeDBInstances service method, as returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

rebootDBInstance

DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. A DBInstance event is created when the reboot is completed.

Parameters:

rebootDBInstanceRequest - Container for the necessary parameters to execute the RebootDBInstance service method on AmazonRDS.

Returns:

The response from the RebootDBInstance service method, as returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

restoreDBInstanceFromDBSnapshot

DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Creates a new DB Instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

Parameters:

restoreDBInstanceFromDBSnapshotRequest - Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot service method on AmazonRDS.

Returns:

The response from the RestoreDBInstanceFromDBSnapshot service method, as returned by AmazonRDS.

Throws:

InvalidRestoreException

InstanceQuotaExceededException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBSnapshotStateException

InsufficientDBInstanceCapacityException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

authorizeDBSecurityGroupIngress

DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB Instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB Instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial .

Parameters:

authorizeDBSecurityGroupIngressRequest - Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress service method on AmazonRDS.

Returns:

The response from the AuthorizeDBSecurityGroupIngress service method, as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

AuthorizationAlreadyExistsException

AuthorizationQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBInstanceReadReplica

DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

Creates a DB Instance that acts as a Read Replica of a source DB Instance.

All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below.

IMPORTANT: The source DB Instance must have backup retention enabled.

Parameters:

createDBInstanceReadReplicaRequest - Container for the necessary parameters to execute the CreateDBInstanceReadReplica service method on AmazonRDS.

Returns:

The response from the CreateDBInstanceReadReplica service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InstanceQuotaExceededException

DBInstanceAlreadyExistsException

DBInstanceNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBInstanceStateException

DBSecurityGroupNotFoundException

InsufficientDBInstanceCapacityException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSnapshots

DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about DBSnapshots. This API supports pagination.

Parameters:

describeDBSnapshotsRequest - Container for the necessary parameters to execute the DescribeDBSnapshots service method on AmazonRDS.

Returns:

The response from the DescribeDBSnapshots service method, as returned by AmazonRDS.

Throws:

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSubnetGroups

DescribeDBSubnetGroupsResult describeDBSubnetGroups()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial .

Returns:

The response from the DescribeDBSubnetGroups service method, as returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeReservedDBInstances

DescribeReservedDBInstancesResult describeReservedDBInstances()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

Returns:

The response from the DescribeReservedDBInstances service method, as returned by AmazonRDS.

Throws:

ReservedDBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSecurityGroups

DescribeDBSecurityGroupsResult describeDBSecurityGroups()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial .

Returns:

The response from the DescribeDBSecurityGroups service method, as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns a list of the available DB engines.

Returns:

The response from the DescribeDBEngineVersions service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBParameterGroups

DescribeDBParameterGroupsResult describeDBParameterGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.

Returns:

The response from the DescribeDBParameterGroups service method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeEvents

DescribeEventsResult describeEvents()
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events specific to a particular DB Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Returns:

The response from the DescribeEvents service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeReservedDBInstancesOfferings

DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Lists available reserved DB Instance offerings.

Returns:

The response from the DescribeReservedDBInstancesOfferings service method, as returned by AmazonRDS.

Throws:

ReservedDBInstancesOfferingNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBInstances

DescribeDBInstancesResult describeDBInstances()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about provisioned RDS instances. This API supports pagination.

Returns:

The response from the DescribeDBInstances service method, as returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSnapshots

DescribeDBSnapshotsResult describeDBSnapshots()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about DBSnapshots. This API supports pagination.

Returns:

The response from the DescribeDBSnapshots service method, as returned by AmazonRDS.

Throws:

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.