|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AmazonRDSAsync
Interface for accessing AmazonRDS asynchronously, using Java Futures.
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 database server. This means the code, applications, and tools you already use today with your existing MySQL 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.
Method Summary | |
---|---|
Future<DBSecurityGroup> |
authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
This API allows for ingress to a DBSecurityGroup using one of two forms of authorization. |
Future<DBInstance> |
createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest)
This API creates a new DB instance. |
Future<DBParameterGroup> |
createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest)
This API creates a new database parameter group. |
Future<DBSecurityGroup> |
createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
This API creates a new database security group. |
Future<DBSnapshot> |
createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest)
This API is used to create a DBSnapshot. |
Future<DBInstance> |
deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest)
The DeleteDBInstance API deletes a previously provisioned RDS instance. |
Future<Void> |
deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
This API deletes a particular DBParameterGroup. |
Future<Void> |
deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
This API deletes a database security group. |
Future<DBSnapshot> |
deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
This API is used to delete a DBSnapshot. |
Future<DescribeDBInstancesResult> |
describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest)
This API is used to retrieve information about provisioned RDS instances. |
Future<DescribeDBParameterGroupsResult> |
describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
This API returns a list of DBParameterGroup descriptions. |
Future<DescribeDBParametersResult> |
describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest)
This API returns the detailed parameter list for a particular DBParameterGroup. |
Future<DescribeDBSecurityGroupsResult> |
describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
This API returns a list of DBSecurityGroup descriptions. |
Future<DescribeDBSnapshotsResult> |
describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
This API is used to retrieve information about DBSnapshots. |
Future<EngineDefaults> |
describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
This API returns the default engine and system parameter information for the specified database engine. |
Future<DescribeEventsResult> |
describeEventsAsync(DescribeEventsRequest describeEventsRequest)
This API returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 das. |
Future<DBInstance> |
modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest)
This API is used to change RDS Instance settings. |
Future<ModifyDBParameterGroupResult> |
modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
This API modifies the parameters of a DBParameterGroup. |
Future<DBInstance> |
rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest)
The RebootDBInstance API reboots a previously provisioned RDS instance. |
Future<ResetDBParameterGroupResult> |
resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
This API modifies the parameters of a DBParameterGroup to the engine/system default value. |
Future<DBInstance> |
restoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)
This API creates a new DB Instance to an arbitrary point-in-time. |
Future<DBInstance> |
restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
This API creates a new RDS instance from a point-in-time system snapshot. |
Future<DBSecurityGroup> |
revokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)
This API revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups. |
Method Detail |
---|
Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest) throws AmazonServiceException, AmazonClientException
This API is used to change RDS Instance settings. Users call the ModifyDBInstance API to change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDBInstanceRequest
- Container for the necessary parameters
to execute the ModifyDBInstance operation on AmazonRDS.
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.Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
This API 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 MySQL reboot or RebootDBInstance request.
resetDBParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBParameterGroup operation on
AmazonRDS.
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.Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
This API 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.
modifyDBParameterGroupRequest
- Container for the necessary
parameters to execute the ModifyDBParameterGroup operation on
AmazonRDS.
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.Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest) throws AmazonServiceException, AmazonClientException
This API returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 das. Events specific to a particular DB Instance, database security group, database snapshot or database parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEventsRequest
- Container for the necessary parameters to
execute the DescribeEvents operation on AmazonRDS.
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.Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AmazonServiceException, AmazonClientException
This API returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
operation on AmazonRDS.
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.Future<DBInstance> restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) throws AmazonServiceException, AmazonClientException
This API creates a new RDS instance from a point-in-time system 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.
restoreDBInstanceToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceToPointInTime
operation on AmazonRDS.
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.Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) throws AmazonServiceException, AmazonClientException
This API is used to retrieve information about DBSnapshots. This API supports pagination.
describeDBSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshots operation on AmazonRDS.
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.Future<Void> deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
This API deletes a database security group. Database security group must not be associated with any RDS Instances.
deleteDBSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSecurityGroup operation on
AmazonRDS.
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.Future<Void> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
This API deletes a particular DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
deleteDBParameterGroupRequest
- Container for the necessary
parameters to execute the DeleteDBParameterGroup operation on
AmazonRDS.
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.Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) throws AmazonServiceException, AmazonClientException
This API returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the descriptions of the specified DBParameterGroup.
describeDBParameterGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBParameterGroups operation on
AmazonRDS.
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.Future<DBInstance> deleteDBInstanceAsync(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.
deleteDBInstanceRequest
- Container for the necessary parameters
to execute the DeleteDBInstance operation on AmazonRDS.
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.Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
This API is used to delete a DBSnapshot. The DBSnapshot must be in the "available" state to be deleted.
deleteDBSnapshotRequest
- Container for the necessary parameters
to execute the DeleteDBSnapshot operation on AmazonRDS.
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.Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
This API returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.
describeDBSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSecurityGroups operation on
AmazonRDS.
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.Future<DBSecurityGroup> revokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
This API revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups. Required parameters for this API are one of CIDRIP or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).
revokeDBSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeDBSecurityGroupIngress operation on
AmazonRDS.
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.Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest) throws AmazonServiceException, AmazonClientException
This API is used to retrieve information about provisioned RDS instances. DescribeDBInstances supports pagination.
describeDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeDBInstances operation on AmazonRDS.
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.Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
This API is used to create a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshotRequest
- Container for the necessary parameters
to execute the CreateDBSnapshot operation on AmazonRDS.
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.Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest) throws AmazonServiceException, AmazonClientException
This API returns the detailed parameter list for a particular DBParameterGroup.
describeDBParametersRequest
- Container for the necessary
parameters to execute the DescribeDBParameters operation on AmazonRDS.
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.Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest) throws AmazonServiceException, AmazonClientException
This API creates a new DB instance.
createDBInstanceRequest
- Container for the necessary parameters
to execute the CreateDBInstance operation on AmazonRDS.
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.Future<DBInstance> restoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
This API creates a new 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.
restoreDBInstanceFromDBSnapshotRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
operation on AmazonRDS.
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.Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
This API creates a new database security group. Database Security groups control access to a database instance.
createDBSecurityGroupRequest
- Container for the necessary
parameters to execute the CreateDBSecurityGroup operation on
AmazonRDS.
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.Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
This API creates a new database parameter group.
createDBParameterGroupRequest
- Container for the necessary
parameters to execute the CreateDBParameterGroup operation on
AmazonRDS.
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.Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest) throws AmazonServiceException, AmazonClientException
The RebootDBInstance API 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.
rebootDBInstanceRequest
- Container for the necessary parameters
to execute the RebootDBInstance operation on AmazonRDS.
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.Future<DBSecurityGroup> authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
This API allows for ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 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 or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).
authorizeDBSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeDBSecurityGroupIngress
operation on AmazonRDS.
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |