public interface AmazonRDS
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 an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces .
Modifier and Type | Method and Description |
---|---|
EventSubscription |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification
subscription.
|
void |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon RDS resource.
|
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.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an RDS event notification subscription.
|
OptionGroup |
createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
Creates a new option group.
|
DBInstance |
deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)
The DeleteDBInstance action deletes a previously provisioned DB
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.
|
EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an RDS event notification subscription.
|
void |
deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
Deletes an existing option 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.
|
DescribeDBLogFilesResult |
describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)
Returns a list of DB log files for the DB instance.
|
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 DB parameter
group.
|
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups()
Returns a list of
DBSecurityGroup descriptions. |
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
Returns a list of
DBSecurityGroup descriptions. |
DescribeDBSnapshotsResult |
describeDBSnapshots()
Returns information about DB snapshots.
|
DescribeDBSnapshotsResult |
describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
Returns information about DB snapshots.
|
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.
|
DescribeEventCategoriesResult |
describeEventCategories()
Displays a list of categories for all event source types, or, if
specified, for a specified source type.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if
specified, for a specified source type.
|
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.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions()
Lists all the subscription descriptions for a customer account.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
DescribeOptionGroupOptionsResult |
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
|
DescribeOptionGroupsResult |
describeOptionGroups()
Describes the available option groups.
|
DescribeOptionGroupsResult |
describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
Describes the available option groups.
|
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.
|
DownloadDBLogFilePortionResult |
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
Downloads the last line of the specified log file.
|
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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon RDS resource.
|
DBInstance |
modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)
Modify settings for a DB instance.
|
ModifyDBParameterGroupResult |
modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
Modifies the parameters of a DB parameter group.
|
DBSubnetGroup |
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
Modifies an existing DB subnet group.
|
EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing RDS event notification subscription.
|
OptionGroup |
modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
Modifies an existing option group.
|
DBInstance |
promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)
Promotes a read replica DB instance to a standalone DB instance.
|
ReservedDBInstance |
purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
Purchases a reserved DB instance offering.
|
DBInstance |
rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)
Rebooting a DB instance restarts the database engine service.
|
EventSubscription |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing RDS event notification
subscription.
|
void |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon RDS resource.
|
ResetDBParameterGroupResult |
resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
Modifies the parameters of a DB parameter group 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 |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "rds.amazonaws.com") or a full
URL, including the protocol (ex: "https://rds.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
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "rds.amazonaws.com") or a full URL,
including the protocol (ex: "https://rds.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest
- Container for the necessary
parameters to execute the DescribeEventSubscriptions service method on
AmazonRDS.SubscriptionNotFoundException
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.DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) throws AmazonServiceException, AmazonClientException
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance
will be "deleting" until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this
operation. The action cannot be canceled or reverted once submitted.
deleteDBInstanceRequest
- Container for the necessary parameters
to execute the DeleteDBInstance service method on AmazonRDS.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.DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB instance.
createDBInstanceRequest
- Container for the necessary parameters
to execute the CreateDBInstance service method on AmazonRDS.DBParameterGroupNotFoundException
InstanceQuotaExceededException
DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
StorageQuotaExceededException
InvalidVPCNetworkStateException
DBSecurityGroupNotFoundException
InsufficientDBInstanceCapacityException
DBSubnetGroupDoesNotCoverEnoughAZsException
InvalidSubnetException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
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.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.
describeEventsRequest
- Container for the necessary parameters to
execute the DescribeEvents service method 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.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.
deleteDBParameterGroupRequest
- Container for the necessary
parameters to execute the DeleteDBParameterGroup service method on
AmazonRDS.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.DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) throws AmazonServiceException, AmazonClientException
Returns information about DB snapshots. This API supports pagination.
describeDBSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshots service method on
AmazonRDS.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.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 DB security group.
describeDBSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSecurityGroups service method on
AmazonRDS.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.DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB security group. DB security groups control access to a DB instance.
createDBSecurityGroupRequest
- Container for the necessary
parameters to execute the CreateDBSecurityGroup service method on
AmazonRDS.DBSecurityGroupQuotaExceededException
DBSecurityGroupNotSupportedException
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.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.
restoreDBInstanceToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceToPointInTime
service method on AmazonRDS.PointInTimeRestoreNotEnabledException
DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
DBInstanceNotFoundException
InvalidVPCNetworkStateException
InvalidSubnetException
InvalidRestoreException
InstanceQuotaExceededException
StorageQuotaExceededException
InvalidDBInstanceStateException
InsufficientDBInstanceCapacityException
DBSubnetGroupDoesNotCoverEnoughAZsException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
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.DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AmazonServiceException, AmazonClientException
Describes all available options.
describeOptionGroupOptionsRequest
- Container for the necessary
parameters to execute the DescribeOptionGroupOptions service method 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.void deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes an existing option group.
deleteOptionGroupRequest
- Container for the necessary parameters
to execute the DeleteOptionGroup service method on AmazonRDS.InvalidOptionGroupStateException
OptionGroupNotFoundException
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.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 .
describeDBSubnetGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSubnetGroups service method on
AmazonRDS.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.void removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws AmazonServiceException, AmazonClientException
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources .
removeTagsFromResourceRequest
- Container for the necessary
parameters to execute the RemoveTagsFromResource service method on
AmazonRDS.DBInstanceNotFoundException
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.DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest
- Container for the necessary
parameters to execute the DescribeDBParameters service method on
AmazonRDS.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.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.
deleteDBSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSecurityGroup service method on
AmazonRDS.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.DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest
- Container for the
necessary parameters to execute the DescribeOrderableDBInstanceOptions
service method 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.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.
createDBParameterGroupRequest
- Container for the necessary
parameters to execute the CreateDBParameterGroup service method on
AmazonRDS.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.void addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws AmazonServiceException, AmazonClientException
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources .
addTagsToResourceRequest
- Container for the necessary parameters
to execute the AddTagsToResource service method on AmazonRDS.DBInstanceNotFoundException
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonServiceException, AmazonClientException
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources .
listTagsForResourceRequest
- Container for the necessary
parameters to execute the ListTagsForResource service method on
AmazonRDS.DBInstanceNotFoundException
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.DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE:The DBSnapshot must be in the available state to be deleted.
deleteDBSnapshotRequest
- Container for the necessary parameters
to execute the DeleteDBSnapshot service method on AmazonRDS.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.DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
modifyDBSubnetGroupRequest
- Container for the necessary
parameters to execute the ModifyDBSubnetGroup service method on
AmazonRDS.DBSubnetGroupNotFoundException
DBSubnetQuotaExceededException
SubnetAlreadyInUseException
DBSubnetGroupDoesNotCoverEnoughAZsException
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.OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new option group. You can create up to 20 option groups.
createOptionGroupRequest
- Container for the necessary parameters
to execute the CreateOptionGroup service method on AmazonRDS.OptionGroupAlreadyExistsException
OptionGroupQuotaExceededException
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.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 DB parameter group.
describeDBParameterGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBParameterGroups service method on
AmazonRDS.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.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).
revokeDBSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeDBSecurityGroupIngress service method
on AmazonRDS.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.DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) throws AmazonServiceException, AmazonClientException
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferingsRequest
- Container for the
necessary parameters to execute the
DescribeReservedDBInstancesOfferings service method on AmazonRDS.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.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.
createDBInstanceReadReplicaRequest
- Container for the necessary
parameters to execute the CreateDBInstanceReadReplica service method
on AmazonRDS.DBParameterGroupNotFoundException
DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
DBInstanceNotFoundException
InvalidVPCNetworkStateException
InvalidDBSubnetGroupException
DBSecurityGroupNotFoundException
InvalidSubnetException
InstanceQuotaExceededException
DBSubnetGroupNotAllowedException
StorageQuotaExceededException
InvalidDBInstanceStateException
DBSubnetGroupDoesNotCoverEnoughAZsException
InsufficientDBInstanceCapacityException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
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.DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) throws AmazonServiceException, AmazonClientException
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeDBInstances service method on
AmazonRDS.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.ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) throws AmazonServiceException, AmazonClientException
Purchases a reserved DB instance offering.
purchaseReservedDBInstancesOfferingRequest
- Container for the
necessary parameters to execute the
PurchaseReservedDBInstancesOffering service method on AmazonRDS.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.EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
- Container for the
necessary parameters to execute the
RemoveSourceIdentifierFromSubscription service method on AmazonRDS.SourceNotFoundException
SubscriptionNotFoundException
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.EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
service method 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.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.
modifyDBInstanceRequest
- Container for the necessary parameters
to execute the ModifyDBInstance service method on AmazonRDS.DBParameterGroupNotFoundException
DBInstanceAlreadyExistsException
DBInstanceNotFoundException
StorageQuotaExceededException
InvalidVPCNetworkStateException
InvalidDBInstanceStateException
DBSecurityGroupNotFoundException
InvalidDBSecurityGroupStateException
InsufficientDBInstanceCapacityException
DBUpgradeDependencyFailureException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
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.OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing option group.
modifyOptionGroupRequest
- Container for the necessary parameters
to execute the ModifyOptionGroup service method on AmazonRDS.InvalidOptionGroupStateException
OptionGroupNotFoundException
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.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 .
authorizeDBSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeDBSecurityGroupIngress
service method on AmazonRDS.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.EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionRequest
- Container for the
necessary parameters to execute the AddSourceIdentifierToSubscription
service method on AmazonRDS.SourceNotFoundException
SubscriptionNotFoundException
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.ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB parameter group. 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 be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB instances for either dynamic or static parameters. For Microsoft SQL Server DB instances, the pending-reboot method can be used only for static parameters.
modifyDBParameterGroupRequest
- Container for the necessary
parameters to execute the ModifyDBParameterGroup service method on
AmazonRDS.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.DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AmazonServiceException, AmazonClientException
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
describeEventCategoriesRequest
- Container for the necessary
parameters to execute the DescribeEventCategories service method 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.ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB parameter group to the engine/system
default value. To reset specific parameters submit a list of the
following: ParameterName
and ApplyMethod
.
To reset the entire DB parameter group, 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.
resetDBParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBParameterGroup service method on
AmazonRDS.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.DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
createDBSubnetGroupRequest
- Container for the necessary
parameters to execute the CreateDBSubnetGroup service method on
AmazonRDS.DBSubnetQuotaExceededException
DBSubnetGroupAlreadyExistsException
DBSubnetGroupQuotaExceededException
DBSubnetGroupDoesNotCoverEnoughAZsException
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.DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of DB log files for the DB instance.
describeDBLogFilesRequest
- Container for the necessary
parameters to execute the DescribeDBLogFiles service method on
AmazonRDS.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.EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
createEventSubscriptionRequest
- Container for the necessary
parameters to execute the CreateEventSubscription service method on
AmazonRDS.SourceNotFoundException
SNSTopicArnNotFoundException
SNSInvalidTopicException
SubscriptionCategoryNotFoundException
SNSNoAuthorizationException
EventSubscriptionQuotaExceededException
SubscriptionAlreadyExistException
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.DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.
copyDBSnapshotRequest
- Container for the necessary parameters to
execute the CopyDBSnapshot service method on AmazonRDS.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.DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) throws AmazonServiceException, AmazonClientException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeReservedDBInstances service method
on AmazonRDS.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.DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) throws AmazonServiceException, AmazonClientException
Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
rebootDBInstanceRequest
- Container for the necessary parameters
to execute the RebootDBInstance service method on AmazonRDS.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.EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Deletes an RDS event notification subscription.
deleteEventSubscriptionRequest
- Container for the necessary
parameters to execute the DeleteEventSubscription service method on
AmazonRDS.SubscriptionNotFoundException
InvalidEventSubscriptionStateException
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.DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest) throws AmazonServiceException, AmazonClientException
Promotes a read replica DB instance to a standalone DB instance.
promoteReadReplicaRequest
- Container for the necessary
parameters to execute the PromoteReadReplica service method on
AmazonRDS.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.DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the available DB engines.
describeDBEngineVersionsRequest
- Container for the necessary
parameters to execute the DescribeDBEngineVersions service method 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.DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws AmazonServiceException, AmazonClientException
Describes the available option groups.
describeOptionGroupsRequest
- Container for the necessary
parameters to execute the DescribeOptionGroups service method on
AmazonRDS.OptionGroupNotFoundException
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.DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) throws AmazonServiceException, AmazonClientException
Downloads the last line of the specified log file.
downloadDBLogFilePortionRequest
- Container for the necessary
parameters to execute the DownloadDBLogFilePortion service method on
AmazonRDS.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.EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
modifyEventSubscriptionRequest
- Container for the necessary
parameters to execute the ModifyEventSubscription service method on
AmazonRDS.SNSTopicArnNotFoundException
SNSInvalidTopicException
SubscriptionCategoryNotFoundException
SubscriptionNotFoundException
SNSNoAuthorizationException
EventSubscriptionQuotaExceededException
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.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.
restoreDBInstanceFromDBSnapshotRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
service method on AmazonRDS.DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
InvalidVPCNetworkStateException
InvalidDBSnapshotStateException
InvalidSubnetException
DBSnapshotNotFoundException
InvalidRestoreException
InstanceQuotaExceededException
StorageQuotaExceededException
InsufficientDBInstanceCapacityException
DBSubnetGroupDoesNotCoverEnoughAZsException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
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.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.
deleteDBSubnetGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSubnetGroup service method on
AmazonRDS.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.DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
Creates a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshotRequest
- Container for the necessary parameters
to execute the CreateDBSnapshot service method on AmazonRDS.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.DescribeEventSubscriptionsResult describeEventSubscriptions() throws AmazonServiceException, AmazonClientException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
SubscriptionNotFoundException
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.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.
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.DescribeDBSnapshotsResult describeDBSnapshots() throws AmazonServiceException, AmazonClientException
Returns information about DB snapshots. This API supports pagination.
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.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 DB security group.
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.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 .
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.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 DB parameter group.
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.DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings() throws AmazonServiceException, AmazonClientException
Lists available reserved DB instance offerings.
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.DescribeDBInstancesResult describeDBInstances() throws AmazonServiceException, AmazonClientException
Returns information about provisioned RDS instances. This API supports pagination.
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.DescribeEventCategoriesResult describeEventCategories() throws AmazonServiceException, AmazonClientException
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
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.DescribeReservedDBInstancesResult describeReservedDBInstances() throws AmazonServiceException, AmazonClientException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
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.DescribeDBEngineVersionsResult describeDBEngineVersions() throws AmazonServiceException, AmazonClientException
Returns a list of the available DB engines.
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.DescribeOptionGroupsResult describeOptionGroups() throws AmazonServiceException, AmazonClientException
Describes the available option groups.
OptionGroupNotFoundException
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.