Class AmazonRDSClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.rds.AmazonRDSClient
-
- All Implemented Interfaces:
AmazonRDS
- Direct Known Subclasses:
AmazonRDSAsyncClient
@ThreadSafe public class AmazonRDSClient extends AmazonWebServiceClient implements AmazonRDS
Client for accessing Amazon RDS. 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, resizeable 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 MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing 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 interface reference for Amazon RDS 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 might 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. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
-
For the alphabetical list of API actions, see API Actions.
-
For the alphabetical list of data types, see Data Types.
-
For a list of common query parameters, see Common Parameters.
-
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
-
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
-
For more information about how to use the Query API, see Using the Query API.
-
-
Field Summary
Fields Modifier and Type Field Description protected static ClientConfigurationFactory
configFactory
Client configuration factory providing ClientConfigurations tailored to this clientprotected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AmazonRDSClient()
Constructs a new client to invoke service methods on Amazon RDS.AmazonRDSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials.AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials provider.AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon RDS 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 Amazon RDS using the specified AWS account credentials provider, client configuration options, and request metric collector.AmazonRDSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials and client configuration options.AmazonRDSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon RDS.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EventSubscription
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification subscription.AddTagsToResourceResult
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon RDS resource.ResourcePendingMaintenanceActions
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).DBSecurityGroup
authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
Enables ingress to a DBSecurityGroup using one of two forms of authorization.DBClusterSnapshot
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)
Creates a snapshot of a DB cluster.DBParameterGroup
copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest)
Copies the specified DB parameter group.DBSnapshot
copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)
Copies the specified DB snapshot.OptionGroup
copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest)
Copies the specified option group.DBCluster
createDBCluster(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon Aurora DB cluster.DBClusterParameterGroup
createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)
Creates a new DB cluster parameter group.DBClusterSnapshot
createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)
Creates a snapshot of a DB cluster.DBInstance
createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
Creates a new DB instance.DBInstance
createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL 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.DBCluster
deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)
The DeleteDBCluster action deletes a previously provisioned DB cluster.DeleteDBClusterParameterGroupResult
deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)
Deletes a specified DB cluster parameter group.DBClusterSnapshot
deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)
Deletes a DB cluster snapshot.DBInstance
deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)
The DeleteDBInstance action deletes a previously provisioned DB instance.DeleteDBParameterGroupResult
deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
Deletes a specified DBParameterGroup.DeleteDBSecurityGroupResult
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
Deletes a DB security group.DBSnapshot
deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
Deletes a DBSnapshot.DeleteDBSubnetGroupResult
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a DB subnet group.EventSubscription
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an RDS event notification subscription.DeleteOptionGroupResult
deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
Deletes an existing option group.DescribeAccountAttributesResult
describeAccountAttributes()
Simplified method form for invoking the DescribeAccountAttributes operation.DescribeAccountAttributesResult
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Lists all of the attributes for a customer account.DescribeCertificatesResult
describeCertificates()
Simplified method form for invoking the DescribeCertificates operation.DescribeCertificatesResult
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.DescribeDBClusterParameterGroupsResult
describeDBClusterParameterGroups()
Simplified method form for invoking the DescribeDBClusterParameterGroups operation.DescribeDBClusterParameterGroupsResult
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
Returns a list ofDBClusterParameterGroup
descriptions.DescribeDBClusterParametersResult
describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.DescribeDBClustersResult
describeDBClusters()
Simplified method form for invoking the DescribeDBClusters operation.DescribeDBClustersResult
describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)
Returns information about provisioned Aurora DB clusters.DescribeDBClusterSnapshotsResult
describeDBClusterSnapshots()
Simplified method form for invoking the DescribeDBClusterSnapshots operation.DescribeDBClusterSnapshotsResult
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
Returns information about DB cluster snapshots.DescribeDBEngineVersionsResult
describeDBEngineVersions()
Simplified method form for invoking the DescribeDBEngineVersions operation.DescribeDBEngineVersionsResult
describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available DB engines.DescribeDBInstancesResult
describeDBInstances()
Simplified method form for invoking the DescribeDBInstances operation.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()
Simplified method form for invoking the DescribeDBParameterGroups operation.DescribeDBParameterGroupsResult
describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
Returns a list ofDBParameterGroup
descriptions.DescribeDBParametersResult
describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.DescribeDBSecurityGroupsResult
describeDBSecurityGroups()
Simplified method form for invoking the DescribeDBSecurityGroups operation.DescribeDBSecurityGroupsResult
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
Returns a list ofDBSecurityGroup
descriptions.DBSnapshotAttributesResult
describeDBSnapshotAttributes()
Simplified method form for invoking the DescribeDBSnapshotAttributes operation.DBSnapshotAttributesResult
describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.DescribeDBSnapshotsResult
describeDBSnapshots()
Simplified method form for invoking the DescribeDBSnapshots operation.DescribeDBSnapshotsResult
describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
Returns information about DB snapshots.DescribeDBSubnetGroupsResult
describeDBSubnetGroups()
Simplified method form for invoking the DescribeDBSubnetGroups operation.DescribeDBSubnetGroupsResult
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.EngineDefaults
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.EngineDefaults
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.DescribeEventCategoriesResult
describeEventCategories()
Simplified method form for invoking the DescribeEventCategories operation.DescribeEventCategoriesResult
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.DescribeEventsResult
describeEvents()
Simplified method form for invoking the DescribeEvents operation.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()
Simplified method form for invoking the DescribeEventSubscriptions operation.DescribeEventSubscriptionsResult
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.DescribeOptionGroupOptionsResult
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.DescribeOptionGroupsResult
describeOptionGroups()
Simplified method form for invoking the DescribeOptionGroups operation.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.DescribePendingMaintenanceActionsResult
describePendingMaintenanceActions()
Simplified method form for invoking the DescribePendingMaintenanceActions operation.DescribePendingMaintenanceActionsResult
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.DescribeReservedDBInstancesResult
describeReservedDBInstances()
Simplified method form for invoking the DescribeReservedDBInstances operation.DescribeReservedDBInstancesResult
describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.DescribeReservedDBInstancesOfferingsResult
describeReservedDBInstancesOfferings()
Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.DescribeReservedDBInstancesOfferingsResult
describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
Lists available reserved DB instance offerings.DownloadDBLogFilePortionResult
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
Downloads all or a portion of the specified log file, up to 1 MB in size.DBCluster
failoverDBCluster()
Simplified method form for invoking the FailoverDBCluster operation.DBCluster
failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)
Forces a failover for a DB cluster.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.DBCluster
modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)
Modify a setting for an Amazon Aurora DB cluster.ModifyDBClusterParameterGroupResult
modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group.DBInstance
modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)
Modify settings for a DB instance.ModifyDBParameterGroupResult
modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
Modifies the parameters of a DB parameter group.DBSnapshotAttributesResult
modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.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.RemoveTagsFromResourceResult
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon RDS resource.ResetDBClusterParameterGroupResult
resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group to the default value.ResetDBParameterGroupResult
resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
Modifies the parameters of a DB parameter group to the engine/system default value.DBCluster
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
Creates a new DB cluster from a DB cluster snapshot.DBCluster
restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time.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, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, 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
-
configFactory
protected static final ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
exceptionUnmarshallers
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions
-
-
Constructor Detail
-
AmazonRDSClient
public AmazonRDSClient()
Constructs a new client to invoke service methods on Amazon RDS. 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
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonRDSClient
public AmazonRDSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon RDS. 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
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon RDS (ex: proxy settings, retry counts, etc.).- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonRDSClient
public AmazonRDSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonRDSClient
public AmazonRDSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon RDS (ex: proxy settings, retry counts, etc.).
-
AmazonRDSClient
public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonRDSClient
public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon RDS (ex: proxy settings, retry counts, etc.).
-
AmazonRDSClient
public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon RDS (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Detail
-
addSourceIdentifierToSubscription
public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification subscription.
- Specified by:
addSourceIdentifierToSubscription
in interfaceAmazonRDS
- Parameters:
addSourceIdentifierToSubscriptionRequest
-- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.
-
addTagsToResource
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
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 a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
- Specified by:
addTagsToResource
in interfaceAmazonRDS
- Parameters:
addTagsToResourceRequest
-- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
applyPendingMaintenanceAction
public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
- Specified by:
applyPendingMaintenanceAction
in interfaceAmazonRDS
- Parameters:
applyPendingMaintenanceActionRequest
-- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource ID was not found.
-
authorizeDBSecurityGroupIngress
public DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
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).
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.
- Specified by:
authorizeDBSecurityGroupIngress
in interfaceAmazonRDS
- Parameters:
authorizeDBSecurityGroupIngressRequest
-- Returns:
- Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
- Throws:
DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.AuthorizationAlreadyExistsException
- The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.AuthorizationQuotaExceededException
- DB security group authorization quota has been reached.
-
copyDBClusterSnapshot
public DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
copyDBClusterSnapshot
in interfaceAmazonRDS
- Parameters:
copyDBClusterSnapshotRequest
-- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- Throws:
DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.
-
copyDBParameterGroup
public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest)
Copies the specified DB parameter group.
- Specified by:
copyDBParameterGroup
in interfaceAmazonRDS
- Parameters:
copyDBParameterGroupRequest
-- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.
-
copyDBSnapshot
public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)
Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.
If you are copying from a shared manual DB snapshot, the
SourceDBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Specified by:
copyDBSnapshot
in interfaceAmazonRDS
- Parameters:
copyDBSnapshotRequest
-- Returns:
- Result of the CopyDBSnapshot operation returned by the service.
- Throws:
DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
copyOptionGroup
public OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest)
Copies the specified option group.
- Specified by:
copyOptionGroup
in interfaceAmazonRDS
- Parameters:
copyOptionGroupRequest
-- Returns:
- Result of the CopyOptionGroup operation returned by the service.
- Throws:
OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupNotFoundException
- The specified option group could not be found.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this AWS account.
-
createDBCluster
public DBCluster createDBCluster(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
createDBCluster
in interfaceAmazonRDS
- Parameters:
createDBClusterRequest
-- Returns:
- Result of the CreateDBCluster operation returned by the service.
- Throws:
DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.KMSKeyNotAccessibleException
- Error accessing KMS key.DBClusterNotFoundException
- DBClusterIdentifier
-
createDBClusterParameterGroup
public DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
createDBClusterParameterGroup
in interfaceAmazonRDS
- Parameters:
createDBClusterParameterGroupRequest
-- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- Throws:
DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.
-
createDBClusterSnapshot
public DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
createDBClusterSnapshot
in interfaceAmazonRDS
- Parameters:
createDBClusterSnapshotRequest
-- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- Throws:
DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.DBClusterNotFoundException
- DBClusterIdentifierSnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.
-
createDBInstance
public DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
Creates a new DB instance.
- Specified by:
createDBInstance
in interfaceAmazonRDS
- Parameters:
createDBInstanceRequest
-- Returns:
- Result of the CreateDBInstance operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBClusterNotFoundException
- DBClusterIdentifierStorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DomainNotFoundException
-
createDBInstanceReadReplica
public DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL 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.
The source DB instance must have backup retention enabled.
- Specified by:
createDBInstanceReadReplica
in interfaceAmazonRDS
- Parameters:
createDBInstanceReadReplicaRequest
-- Returns:
- Result of the CreateDBInstanceReadReplica operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBSubnetGroupNotAllowedException
- Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.InvalidDBSubnetGroupException
- Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
createDBParameterGroup
public DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest)
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 without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Specified by:
createDBParameterGroup
in interfaceAmazonRDS
- Parameters:
createDBParameterGroupRequest
-- Returns:
- Result of the CreateDBParameterGroup operation returned by the service.
- Throws:
DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.
-
createDBSecurityGroup
public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
Creates a new DB security group. DB security groups control access to a DB instance.
- Specified by:
createDBSecurityGroup
in interfaceAmazonRDS
- Parameters:
createDBSecurityGroupRequest
-- Returns:
- Result of the CreateDBSecurityGroup operation returned by the service.
- Throws:
DBSecurityGroupAlreadyExistsException
- A DB security group with the name specified in DBSecurityGroupName already exists.DBSecurityGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB security groups.DBSecurityGroupNotSupportedException
- A DB security group is not allowed for this action.
-
createDBSnapshot
public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest)
Creates a DBSnapshot. The source DBInstance must be in "available" state.
- Specified by:
createDBSnapshot
in interfaceAmazonRDS
- Parameters:
createDBSnapshotRequest
-- Returns:
- Result of the CreateDBSnapshot operation returned by the service.
- Throws:
DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.
-
createDBSubnetGroup
public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
- Specified by:
createDBSubnetGroup
in interfaceAmazonRDS
- Parameters:
createDBSubnetGroupRequest
-- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- Throws:
DBSubnetGroupAlreadyExistsException
- DBSubnetGroupName is already used by an existing DB subnet group.DBSubnetGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB subnet groups.DBSubnetQuotaExceededException
- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
createEventSubscription
public EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
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.
- Specified by:
createEventSubscription
in interfaceAmazonRDS
- Parameters:
createEventSubscriptionRequest
-- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException
- The supplied subscription name already exists.SNSInvalidTopicException
- SNS has responded that there is a problem with the SND topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SourceNotFoundException
- The requested source could not be found.
-
createOptionGroup
public OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
Creates a new option group. You can create up to 20 option groups.
- Specified by:
createOptionGroup
in interfaceAmazonRDS
- Parameters:
createOptionGroupRequest
-- Returns:
- Result of the CreateOptionGroup operation returned by the service.
- Throws:
OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this AWS account.
-
deleteDBCluster
public DBCluster deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
deleteDBCluster
in interfaceAmazonRDS
- Parameters:
deleteDBClusterRequest
-- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.
-
deleteDBClusterParameterGroup
public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
deleteDBClusterParameterGroup
in interfaceAmazonRDS
- Parameters:
deleteDBClusterParameterGroupRequest
-- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
deleteDBClusterSnapshot
public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be deleted.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
deleteDBClusterSnapshot
in interfaceAmazonRDS
- Parameters:
deleteDBClusterSnapshotRequest
-- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- Throws:
InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
-
deleteDBInstance
public DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)
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.Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
- Specified by:
deleteDBInstance
in interfaceAmazonRDS
- Parameters:
deleteDBInstanceRequest
-- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.
-
deleteDBParameterGroup
public DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
- Specified by:
deleteDBParameterGroup
in interfaceAmazonRDS
- Parameters:
deleteDBParameterGroupRequest
-- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
deleteDBSecurityGroup
public DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances. - Specified by:
deleteDBSecurityGroup
in interfaceAmazonRDS
- Parameters:
deleteDBSecurityGroupRequest
-- Returns:
- Result of the DeleteDBSecurityGroup operation returned by the service.
- Throws:
InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.
-
deleteDBSnapshot
public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
The DBSnapshot must be in the available
state to be deleted.- Specified by:
deleteDBSnapshot
in interfaceAmazonRDS
- Parameters:
deleteDBSnapshotRequest
-- Returns:
- Result of the DeleteDBSnapshot operation returned by the service.
- Throws:
InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
deleteDBSubnetGroup
public DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances. - Specified by:
deleteDBSubnetGroup
in interfaceAmazonRDS
- Parameters:
deleteDBSubnetGroupRequest
-- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- Throws:
InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidDBSubnetStateException
- The DB subnet is not in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.
-
deleteEventSubscription
public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an RDS event notification subscription.
- Specified by:
deleteEventSubscription
in interfaceAmazonRDS
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.InvalidEventSubscriptionStateException
- This error can occur if someone else is modifying a subscription. You should retry the action.
-
deleteOptionGroup
public DeleteOptionGroupResult deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
Deletes an existing option group.
- Specified by:
deleteOptionGroup
in interfaceAmazonRDS
- Parameters:
deleteOptionGroupRequest
-- Returns:
- Result of the DeleteOptionGroup operation returned by the service.
- Throws:
OptionGroupNotFoundException
- The specified option group could not be found.InvalidOptionGroupStateException
- The option group is not in the available state.
-
describeAccountAttributes
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
- Specified by:
describeAccountAttributes
in interfaceAmazonRDS
- Parameters:
describeAccountAttributesRequest
-- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
-
describeAccountAttributes
public DescribeAccountAttributesResult describeAccountAttributes()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeAccountAttributes operation.- Specified by:
describeAccountAttributes
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeAccountAttributes(DescribeAccountAttributesRequest)
-
describeCertificates
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
- Specified by:
describeCertificates
in interfaceAmazonRDS
- Parameters:
describeCertificatesRequest
-- Returns:
- Result of the DescribeCertificates operation returned by the service.
- Throws:
CertificateNotFoundException
- CertificateIdentifier
-
describeCertificates
public DescribeCertificatesResult describeCertificates()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeCertificates operation.- Specified by:
describeCertificates
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeCertificates(DescribeCertificatesRequest)
-
describeDBClusterParameterGroups
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusterParameterGroups
in interfaceAmazonRDS
- Parameters:
describeDBClusterParameterGroupsRequest
-- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBClusterParameterGroups
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBClusterParameterGroups operation.- Specified by:
describeDBClusterParameterGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest)
-
describeDBClusterParameters
public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusterParameters
in interfaceAmazonRDS
- Parameters:
describeDBClusterParametersRequest
-- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBClusterSnapshots
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusterSnapshots
in interfaceAmazonRDS
- Parameters:
describeDBClusterSnapshotsRequest
-- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
-
describeDBClusterSnapshots
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBClusterSnapshots operation.- Specified by:
describeDBClusterSnapshots
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)
-
describeDBClusters
public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeDBClusters
in interfaceAmazonRDS
- Parameters:
describeDBClustersRequest
-- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifier
-
describeDBClusters
public DescribeDBClustersResult describeDBClusters()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBClusters operation.- Specified by:
describeDBClusters
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBClusters(DescribeDBClustersRequest)
-
describeDBEngineVersions
public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available DB engines.
- Specified by:
describeDBEngineVersions
in interfaceAmazonRDS
- Parameters:
describeDBEngineVersionsRequest
-- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
-
describeDBEngineVersions
public DescribeDBEngineVersionsResult describeDBEngineVersions()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBEngineVersions operation.- Specified by:
describeDBEngineVersions
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBEngineVersions(DescribeDBEngineVersionsRequest)
-
describeDBInstances
public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned RDS instances. This API supports pagination.
- Specified by:
describeDBInstances
in interfaceAmazonRDS
- Parameters:
describeDBInstancesRequest
-- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
describeDBInstances
public DescribeDBInstancesResult describeDBInstances()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBInstances operation.- Specified by:
describeDBInstances
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBInstances(DescribeDBInstancesRequest)
-
describeDBLogFiles
public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)
Returns a list of DB log files for the DB instance.
- Specified by:
describeDBLogFiles
in interfaceAmazonRDS
- Parameters:
describeDBLogFilesRequest
-- Returns:
- Result of the DescribeDBLogFiles operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
describeDBParameterGroups
public DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Specified by:
describeDBParameterGroups
in interfaceAmazonRDS
- Parameters:
describeDBParameterGroupsRequest
-- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBParameterGroups
public DescribeDBParameterGroupsResult describeDBParameterGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBParameterGroups operation.- Specified by:
describeDBParameterGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBParameterGroups(DescribeDBParameterGroupsRequest)
-
describeDBParameters
public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
- Specified by:
describeDBParameters
in interfaceAmazonRDS
- Parameters:
describeDBParametersRequest
-- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBSecurityGroups
public DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
Returns a list of
DBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.- Specified by:
describeDBSecurityGroups
in interfaceAmazonRDS
- Parameters:
describeDBSecurityGroupsRequest
-- Returns:
- Result of the DescribeDBSecurityGroups operation returned by the service.
- Throws:
DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.
-
describeDBSecurityGroups
public DescribeDBSecurityGroupsResult describeDBSecurityGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSecurityGroups operation.- Specified by:
describeDBSecurityGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSecurityGroups(DescribeDBSecurityGroupsRequest)
-
describeDBSnapshotAttributes
public DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts,
DescribeDBSnapshotAttributes
returns therestore
attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API.
- Specified by:
describeDBSnapshotAttributes
in interfaceAmazonRDS
- Parameters:
describeDBSnapshotAttributesRequest
-- Returns:
- Result of the DescribeDBSnapshotAttributes operation returned by the service.
- Throws:
DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
describeDBSnapshotAttributes
public DBSnapshotAttributesResult describeDBSnapshotAttributes()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSnapshotAttributes operation.- Specified by:
describeDBSnapshotAttributes
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)
-
describeDBSnapshots
public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
Returns information about DB snapshots. This API supports pagination.
- Specified by:
describeDBSnapshots
in interfaceAmazonRDS
- Parameters:
describeDBSnapshotsRequest
-- Returns:
- Result of the DescribeDBSnapshots operation returned by the service.
- Throws:
DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
describeDBSnapshots
public DescribeDBSnapshotsResult describeDBSnapshots()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSnapshots operation.- Specified by:
describeDBSnapshots
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSnapshots(DescribeDBSnapshotsRequest)
-
describeDBSubnetGroups
public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
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.
- Specified by:
describeDBSubnetGroups
in interfaceAmazonRDS
- Parameters:
describeDBSubnetGroupsRequest
-- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.
-
describeDBSubnetGroups
public DescribeDBSubnetGroupsResult describeDBSubnetGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeDBSubnetGroups operation.- Specified by:
describeDBSubnetGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeDBSubnetGroups(DescribeDBSubnetGroupsRequest)
-
describeEngineDefaultClusterParameters
public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
describeEngineDefaultClusterParameters
in interfaceAmazonRDS
- Parameters:
describeEngineDefaultClusterParametersRequest
-- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
-
describeEngineDefaultParameters
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
- Specified by:
describeEngineDefaultParameters
in interfaceAmazonRDS
- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
-
describeEventCategories
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
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.
- Specified by:
describeEventCategories
in interfaceAmazonRDS
- Parameters:
describeEventCategoriesRequest
-- Returns:
- Result of the DescribeEventCategories operation returned by the service.
-
describeEventCategories
public DescribeEventCategoriesResult describeEventCategories()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeEventCategories operation.- Specified by:
describeEventCategories
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeEventCategories(DescribeEventCategoriesRequest)
-
describeEventSubscriptions
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
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.
- Specified by:
describeEventSubscriptions
in interfaceAmazonRDS
- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.
-
describeEventSubscriptions
public DescribeEventSubscriptionsResult describeEventSubscriptions()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeEventSubscriptions operation.- Specified by:
describeEventSubscriptions
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeEventSubscriptions(DescribeEventSubscriptionsRequest)
-
describeEvents
public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
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.
- Specified by:
describeEvents
in interfaceAmazonRDS
- Parameters:
describeEventsRequest
-- Returns:
- Result of the DescribeEvents operation returned by the service.
-
describeEvents
public DescribeEventsResult describeEvents()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeEvents operation.- Specified by:
describeEvents
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeEvents(DescribeEventsRequest)
-
describeOptionGroupOptions
public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
- Specified by:
describeOptionGroupOptions
in interfaceAmazonRDS
- Parameters:
describeOptionGroupOptionsRequest
-- Returns:
- Result of the DescribeOptionGroupOptions operation returned by the service.
-
describeOptionGroups
public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
Describes the available option groups.
- Specified by:
describeOptionGroups
in interfaceAmazonRDS
- Parameters:
describeOptionGroupsRequest
-- Returns:
- Result of the DescribeOptionGroups operation returned by the service.
- Throws:
OptionGroupNotFoundException
- The specified option group could not be found.
-
describeOptionGroups
public DescribeOptionGroupsResult describeOptionGroups()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeOptionGroups operation.- Specified by:
describeOptionGroups
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeOptionGroups(DescribeOptionGroupsRequest)
-
describeOrderableDBInstanceOptions
public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
- Specified by:
describeOrderableDBInstanceOptions
in interfaceAmazonRDS
- Parameters:
describeOrderableDBInstanceOptionsRequest
-- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
-
describePendingMaintenanceActions
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Specified by:
describePendingMaintenanceActions
in interfaceAmazonRDS
- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource ID was not found.
-
describePendingMaintenanceActions
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribePendingMaintenanceActions operation.- Specified by:
describePendingMaintenanceActions
in interfaceAmazonRDS
- See Also:
AmazonRDS.describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
-
describeReservedDBInstances
public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Specified by:
describeReservedDBInstances
in interfaceAmazonRDS
- Parameters:
describeReservedDBInstancesRequest
-- Returns:
- Result of the DescribeReservedDBInstances operation returned by the service.
- Throws:
ReservedDBInstanceNotFoundException
- The specified reserved DB Instance not found.
-
describeReservedDBInstances
public DescribeReservedDBInstancesResult describeReservedDBInstances()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeReservedDBInstances operation.- Specified by:
describeReservedDBInstances
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeReservedDBInstances(DescribeReservedDBInstancesRequest)
-
describeReservedDBInstancesOfferings
public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
- Specified by:
describeReservedDBInstancesOfferings
in interfaceAmazonRDS
- Parameters:
describeReservedDBInstancesOfferingsRequest
-- Returns:
- Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
- Throws:
ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.
-
describeReservedDBInstancesOfferings
public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
Description copied from interface:AmazonRDS
Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.- Specified by:
describeReservedDBInstancesOfferings
in interfaceAmazonRDS
- See Also:
AmazonRDS.describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest)
-
downloadDBLogFilePortion
public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
Downloads all or a portion of the specified log file, up to 1 MB in size.
- Specified by:
downloadDBLogFilePortion
in interfaceAmazonRDS
- Parameters:
downloadDBLogFilePortionRequest
-- Returns:
- Result of the DownloadDBLogFilePortion operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBLogFileNotFoundException
- LogFileName
-
failoverDBCluster
public DBCluster failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
failoverDBCluster
in interfaceAmazonRDS
- Parameters:
failoverDBClusterRequest
-- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.
-
failoverDBCluster
public DBCluster failoverDBCluster()
Description copied from interface:AmazonRDS
Simplified method form for invoking the FailoverDBCluster operation.- Specified by:
failoverDBCluster
in interfaceAmazonRDS
- See Also:
AmazonRDS.failoverDBCluster(FailoverDBClusterRequest)
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
- Specified by:
listTagsForResource
in interfaceAmazonRDS
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
modifyDBCluster
public DBCluster modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
modifyDBCluster
in interfaceAmazonRDS
- Parameters:
modifyDBClusterRequest
-- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.
-
modifyDBClusterParameterGroup
public ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.- Specified by:
modifyDBClusterParameterGroup
in interfaceAmazonRDS
- Parameters:
modifyDBClusterParameterGroupRequest
-- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.
-
modifyDBInstance
public DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)
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.
- Specified by:
modifyDBInstance
in interfaceAmazonRDS
- Parameters:
modifyDBInstanceRequest
-- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- Throws:
InvalidDBInstanceStateException
- The specified DB instance is not in the available state.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBUpgradeDependencyFailureException
- The DB upgrade failed because a resource the DB depends on could not be modified.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
CertificateNotFoundException
- CertificateIdentifierDomainNotFoundException
-
modifyDBParameterGroup
public ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Specified by:
modifyDBParameterGroup
in interfaceAmazonRDS
- Parameters:
modifyDBParameterGroupRequest
-- Returns:
- Result of the ModifyDBParameterGroup operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.
-
modifyDBSnapshotAttribute
public DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of the AWS account ids that are authorized to restore the manual DB snapshot. Uses the valueall
to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add theall
value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.
If the manual DB snapshot is encrypted, it cannot be shared.
- Specified by:
modifyDBSnapshotAttribute
in interfaceAmazonRDS
- Parameters:
modifyDBSnapshotAttributeRequest
-- Returns:
- Result of the ModifyDBSnapshotAttribute operation returned by the service.
- Throws:
DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of account ids that you can share a manual DB snapshot with.
-
modifyDBSubnetGroup
public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
- Specified by:
modifyDBSubnetGroup
in interfaceAmazonRDS
- Parameters:
modifyDBSubnetGroupRequest
-- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- Throws:
DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetQuotaExceededException
- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException
- The DB subnet is already in use in the Availability Zone.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
modifyEventSubscription
public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
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.
- Specified by:
modifyEventSubscription
in interfaceAmazonRDS
- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException
- The subscription name does not exist.SNSInvalidTopicException
- SNS has responded that there is a problem with the SND topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.
-
modifyOptionGroup
public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
Modifies an existing option group.
- Specified by:
modifyOptionGroup
in interfaceAmazonRDS
- Parameters:
modifyOptionGroupRequest
-- Returns:
- Result of the ModifyOptionGroup operation returned by the service.
- Throws:
InvalidOptionGroupStateException
- The option group is not in the available state.OptionGroupNotFoundException
- The specified option group could not be found.
-
promoteReadReplica
public DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)
Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
- Specified by:
promoteReadReplica
in interfaceAmazonRDS
- Parameters:
promoteReadReplicaRequest
-- Returns:
- Result of the PromoteReadReplica operation returned by the service.
- Throws:
InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
purchaseReservedDBInstancesOffering
public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
Purchases a reserved DB instance offering.
- Specified by:
purchaseReservedDBInstancesOffering
in interfaceAmazonRDS
- Parameters:
purchaseReservedDBInstancesOfferingRequest
-- Returns:
- Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
- Throws:
ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.ReservedDBInstanceAlreadyExistsException
- User already has a reservation with the given identifier.ReservedDBInstanceQuotaExceededException
- Request would exceed the user's DB Instance quota.
-
rebootDBInstance
public DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)
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.
- Specified by:
rebootDBInstance
in interfaceAmazonRDS
- Parameters:
rebootDBInstanceRequest
-- Returns:
- Result of the RebootDBInstance operation returned by the service.
- Throws:
InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
removeSourceIdentifierFromSubscription
public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing RDS event notification subscription.
- Specified by:
removeSourceIdentifierFromSubscription
in interfaceAmazonRDS
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
-- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.
-
removeTagsFromResource
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
- Specified by:
removeTagsFromResource
in interfaceAmazonRDS
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
resetDBClusterParameterGroup
public ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
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. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
resetDBClusterParameterGroup
in interfaceAmazonRDS
- Parameters:
resetDBClusterParameterGroupRequest
-- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
resetDBParameterGroup
public ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
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
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Specified by:
resetDBParameterGroup
in interfaceAmazonRDS
- Parameters:
resetDBParameterGroupRequest
-- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
restoreDBClusterFromSnapshot
public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
restoreDBClusterFromSnapshot
in interfaceAmazonRDS
- Parameters:
restoreDBClusterFromSnapshotRequest
-- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- Throws:
DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifierInsufficientDBClusterCapacityException
- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
restoreDBClusterToPointInTime
public DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Specified by:
restoreDBClusterToPointInTime
in interfaceAmazonRDS
- Parameters:
restoreDBClusterToPointInTimeRequest
-- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- Throws:
DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBClusterNotFoundException
- DBClusterIdentifierDBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifierInsufficientDBClusterCapacityException
- The DB cluster does not have enough capacity for the current operation.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
restoreDBInstanceFromDBSnapshot
public DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Specified by:
restoreDBInstanceFromDBSnapshot
in interfaceAmazonRDS
- Parameters:
restoreDBInstanceFromDBSnapshotRequest
-- Returns:
- Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DomainNotFoundException
-
restoreDBInstanceToPointInTime
public DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
- Specified by:
restoreDBInstanceToPointInTime
in interfaceAmazonRDS
- Parameters:
restoreDBInstanceToPointInTimeRequest
-- Returns:
- Result of the RestoreDBInstanceToPointInTime operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.PointInTimeRestoreNotEnabledException
- SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DomainNotFoundException
-
revokeDBSecurityGroupIngress
public DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)
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).
- Specified by:
revokeDBSecurityGroupIngress
in interfaceAmazonRDS
- Parameters:
revokeDBSecurityGroupIngressRequest
-- Returns:
- Result of the RevokeDBSecurityGroupIngress operation returned by the service.
- Throws:
DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonRDS
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-
-