AmazonRDSClient (AWS SDK for Java 1.7.15 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.rds
Class AmazonRDSClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.rds.AmazonRDSClient

All Implemented Interfaces:: AmazonRDS

Direct Known Subclasses:: AmazonRDSAsyncClient

public class AmazonRDSClient
extends AmazonWebServiceClient
implements AmazonRDS
extends AmazonWebServiceClient
implements AmazonRDS

Client for accessing AmazonRDS. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Relational Database Service

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

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

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

Field Summary
`protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>`	`exceptionUnmarshallers` List of exception unmarshallers for all AmazonRDS exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient
`client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset`

Constructor Summary
`AmazonRDSClient()` Constructs a new client to invoke service methods on AmazonRDS.
`AmazonRDSClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials.
`AmazonRDSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials and client configuration options.
`AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider.
`AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider and client configuration options.
`AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider, client configuration options, and request metric collector.
`AmazonRDSClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonRDS.

Method Summary
`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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.rds.AmazonRDS
`setEndpoint, setRegion, shutdown`

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonRDS exceptions.

Constructor Detail

AmazonRDSClient

public AmazonRDSClient()

Constructs a new client to invoke service methods on AmazonRDS. A credentials provider chain will be used that searches for credentials in this order:

Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
Java System Properties - aws.accessKeyId and aws.secretKey
Instance profile credentials delivered through the Amazon EC2 metadata service