public class AmazonRDSClient extends AmazonWebServiceClient implements AmazonRDS
Amazon Relational Database Service
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, 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 Aurora database server. This means 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 is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces 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. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces .
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all AmazonRDS exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonRDSClient()
Constructs a new client to invoke service methods on
AmazonRDS.
|
AmazonRDSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonRDS using the specified AWS account credentials.
|
AmazonRDSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonRDS using the specified AWS account credentials
and client configuration options.
|
AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonRDS using the specified AWS account credentials provider.
|
AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonRDS using the specified AWS account credentials
provider and client configuration options.
|
AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonRDS using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AmazonRDSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonRDS.
|
Modifier and Type | Method and Description |
---|---|
EventSubscription |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification
subscription.
|
void |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon RDS resource.
|
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 DBSnapshot.
|
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.
|
void |
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.
|
void |
deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
Deletes a specified DBParameterGroup.
|
void |
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
Deletes a DB security group.
|
DBSnapshot |
deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
Deletes a DBSnapshot.
|
void |
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a DB subnet group.
|
EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an RDS event notification subscription.
|
void |
deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
Deletes an existing option group.
|
DescribeAccountAttributesResult |
describeAccountAttributes()
Lists all of the attributes for a customer account.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Lists all of the attributes for a customer account.
|
DescribeCertificatesResult |
describeCertificates()
Lists the set of CA certificates provided by Amazon RDS for this AWS
account.
|
DescribeCertificatesResult |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this AWS
account.
|
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups()
Returns a list of
DBClusterParameterGroup descriptions. |
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
DescribeDBClusterParametersResult |
describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster
parameter group.
|
DescribeDBClustersResult |
describeDBClusters()
Returns information about provisioned Aurora DB clusters.
|
DescribeDBClustersResult |
describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)
Returns information about provisioned Aurora DB clusters.
|
DescribeDBClusterSnapshotsResult |
describeDBClusterSnapshots()
Returns information about DB cluster snapshots.
|
DescribeDBClusterSnapshotsResult |
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
Returns information about DB cluster snapshots.
|
DescribeDBEngineVersionsResult |
describeDBEngineVersions()
Returns a list of the available DB engines.
|
DescribeDBEngineVersionsResult |
describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available DB engines.
|
DescribeDBInstancesResult |
describeDBInstances()
Returns information about provisioned RDS instances.
|
DescribeDBInstancesResult |
describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned RDS instances.
|
DescribeDBLogFilesResult |
describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)
Returns a list of DB log files for the DB instance.
|
DescribeDBParameterGroupsResult |
describeDBParameterGroups()
Returns a list of
DBParameterGroup descriptions. |
DescribeDBParameterGroupsResult |
describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
Returns a list of
DBParameterGroup descriptions. |
DescribeDBParametersResult |
describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
Returns the detailed parameter list for a particular DB parameter
group.
|
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups()
Returns a list of
DBSecurityGroup descriptions. |
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
Returns a list of
DBSecurityGroup descriptions. |
DBSnapshotAttributesResult |
describeDBSnapshotAttributes()
Returns a list of DB snapshot attribute names and values for a manual
DB snapshot.
|
DBSnapshotAttributesResult |
describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest)
Returns a list of DB snapshot attribute names and values for a manual
DB snapshot.
|
DescribeDBSnapshotsResult |
describeDBSnapshots()
Returns information about DB snapshots.
|
DescribeDBSnapshotsResult |
describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
Returns information about DB snapshots.
|
DescribeDBSubnetGroupsResult |
describeDBSubnetGroups()
Returns a list of DBSubnetGroup descriptions.
|
DescribeDBSubnetGroupsResult |
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions.
|
EngineDefaults |
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()
Displays a list of categories for all event source types, or, if
specified, for a specified source type.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if
specified, for a specified source type.
|
DescribeEventsResult |
describeEvents()
Returns events related to DB instances, DB security groups, DB
snapshots, and DB parameter groups for the past 14 days.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to DB instances, DB security groups, DB
snapshots, and DB parameter groups for the past 14 days.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions()
Lists all the subscription descriptions for a customer account.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
DescribeOptionGroupOptionsResult |
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
|
DescribeOptionGroupsResult |
describeOptionGroups()
Describes the available option groups.
|
DescribeOptionGroupsResult |
describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
Describes the available option groups.
|
DescribeOrderableDBInstanceOptionsResult |
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified
engine.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions()
Returns a list of resources (for example, DB instances) that have at
least one pending maintenance action.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at
least one pending maintenance action.
|
DescribeReservedDBInstancesResult |
describeReservedDBInstances()
Returns information about reserved DB instances for this account, or
about a specified reserved DB instance.
|
DescribeReservedDBInstancesResult |
describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
Returns information about reserved DB instances for this account, or
about a specified reserved DB instance.
|
DescribeReservedDBInstancesOfferingsResult |
describeReservedDBInstancesOfferings()
Lists available reserved DB instance offerings.
|
DescribeReservedDBInstancesOfferingsResult |
describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
|
DownloadDBLogFilePortionResult |
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
Downloads all or a portion of the specified log file, up to 1 MB in
size.
|
DBCluster |
failoverDBCluster()
Forces a failover for a DB cluster.
|
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.
|
void |
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonRDSClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonRDSClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonRDS
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonRDSClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonRDSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonRDS
(ex: proxy settings, retry counts, etc.).public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonRDS
(ex: proxy settings, retry counts, etc.).public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonRDS
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest)
Copies the specified option group.
copyOptionGroup
in interface AmazonRDS
copyOptionGroupRequest
- Container for the necessary parameters
to execute the CopyOptionGroup service method on AmazonRDS.OptionGroupAlreadyExistsException
OptionGroupNotFoundException
OptionGroupQuotaExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a DB subnet group.
NOTE:The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroup
in interface AmazonRDS
deleteDBSubnetGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSubnetGroup service method on
AmazonRDS.DBSubnetGroupNotFoundException
InvalidDBSubnetGroupStateException
InvalidDBSubnetStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created with the most of original configuration, but in a system chosen 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.
restoreDBInstanceToPointInTime
in interface AmazonRDS
restoreDBInstanceToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceToPointInTime
service method on AmazonRDS.PointInTimeRestoreNotEnabledException
DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
DBInstanceNotFoundException
InvalidVPCNetworkStateException
StorageTypeNotSupportedException
DBSecurityGroupNotFoundException
InvalidSubnetException
AuthorizationNotFoundException
KMSKeyNotAccessibleException
InvalidRestoreException
InstanceQuotaExceededException
StorageQuotaExceededException
InvalidDBInstanceStateException
DBSubnetGroupDoesNotCoverEnoughAZsException
InsufficientDBInstanceCapacityException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActions
in interface AmazonRDS
describePendingMaintenanceActionsRequest
- Container for the
necessary parameters to execute the DescribePendingMaintenanceActions
service method on AmazonRDS.ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)
Copies the specified DBSnapshot. 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.
copyDBSnapshot
in interface AmazonRDS
copyDBSnapshotRequest
- Container for the necessary parameters to
execute the CopyDBSnapshot service method on AmazonRDS.InvalidDBSnapshotStateException
SnapshotQuotaExceededException
DBSnapshotAlreadyExistsException
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
Describes the available option groups.
describeOptionGroups
in interface AmazonRDS
describeOptionGroupsRequest
- Container for the necessary
parameters to execute the DescribeOptionGroups service method on
AmazonRDS.OptionGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
Creates a new DB security group. DB security groups control access to a DB instance.
createDBSecurityGroup
in interface AmazonRDS
createDBSecurityGroupRequest
- Container for the necessary
parameters to execute the CreateDBSecurityGroup service method on
AmazonRDS.DBSecurityGroupQuotaExceededException
DBSecurityGroupNotSupportedException
DBSecurityGroupAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
Creates a new DB instance.
createDBInstance
in interface AmazonRDS
createDBInstanceRequest
- Container for the necessary parameters
to execute the CreateDBInstance service method on AmazonRDS.DBParameterGroupNotFoundException
DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
InvalidVPCNetworkStateException
StorageTypeNotSupportedException
DBSecurityGroupNotFoundException
InvalidSubnetException
AuthorizationNotFoundException
KMSKeyNotAccessibleException
InstanceQuotaExceededException
StorageQuotaExceededException
DBClusterNotFoundException
InvalidDBClusterStateException
DBSubnetGroupDoesNotCoverEnoughAZsException
InsufficientDBInstanceCapacityException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstances
in interface AmazonRDS
describeDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeDBInstances service method on
AmazonRDS.DBInstanceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscription
in interface AmazonRDS
removeSourceIdentifierFromSubscriptionRequest
- Container for the
necessary parameters to execute the
RemoveSourceIdentifierFromSubscription service method on AmazonRDS.SourceNotFoundException
SubscriptionNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
Deletes a DB security group.
NOTE:The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroup
in interface AmazonRDS
deleteDBSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSecurityGroup service method on
AmazonRDS.DBSecurityGroupNotFoundException
InvalidDBSecurityGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
Returns a list of DBClusterParameterGroup
descriptions.
If a DBClusterParameterGroupName
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.
describeDBClusterParameterGroups
in interface AmazonRDS
describeDBClusterParameterGroupsRequest
- Container for the
necessary parameters to execute the DescribeDBClusterParameterGroups
service method on AmazonRDS.DBParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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).
NOTE: You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial .
authorizeDBSecurityGroupIngress
in interface AmazonRDS
authorizeDBSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeDBSecurityGroupIngress
service method on AmazonRDS.DBSecurityGroupNotFoundException
InvalidDBSecurityGroupStateException
AuthorizationAlreadyExistsException
AuthorizationQuotaExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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 the
restore
attribute and a list of the AWS account ids that
are authorized to copy or restore the manual DB snapshot. If
all
is included in the list of values for the
restore
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.
describeDBSnapshotAttributes
in interface AmazonRDS
describeDBSnapshotAttributesRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshotAttributes service method
on AmazonRDS.DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
IMPORTANT: 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.
createDBClusterParameterGroup
in interface AmazonRDS
createDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the CreateDBClusterParameterGroup
service method on AmazonRDS.DBParameterGroupQuotaExceededException
DBParameterGroupAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceAction
in interface AmazonRDS
applyPendingMaintenanceActionRequest
- Container for the
necessary parameters to execute the ApplyPendingMaintenanceAction
service method on AmazonRDS.ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
modifyDBInstance
in interface AmazonRDS
modifyDBInstanceRequest
- Container for the necessary parameters
to execute the ModifyDBInstance service method on AmazonRDS.DBParameterGroupNotFoundException
CertificateNotFoundException
DBInstanceAlreadyExistsException
DBInstanceNotFoundException
InvalidVPCNetworkStateException
StorageTypeNotSupportedException
DBSecurityGroupNotFoundException
DBUpgradeDependencyFailureException
AuthorizationNotFoundException
StorageQuotaExceededException
InvalidDBInstanceStateException
InsufficientDBInstanceCapacityException
InvalidDBSecurityGroupStateException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an RDS event notification subscription.
deleteEventSubscription
in interface AmazonRDS
deleteEventSubscriptionRequest
- Container for the necessary
parameters to execute the DeleteEventSubscription service method on
AmazonRDS.SubscriptionNotFoundException
InvalidEventSubscriptionStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeDBClusterSnapshots
in interface AmazonRDS
describeDBClusterSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBClusterSnapshots service method on
AmazonRDS.DBClusterSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeDBClusterParameters
in interface AmazonRDS
describeDBClusterParametersRequest
- Container for the necessary
parameters to execute the DescribeDBClusterParameters service method
on AmazonRDS.DBParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void 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 .
removeTagsFromResource
in interface AmazonRDS
removeTagsFromResourceRequest
- Container for the necessary
parameters to execute the RemoveTagsFromResource service method on
AmazonRDS.DBInstanceNotFoundException
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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 the AttributeName
and use the
ValuesToAdd
parameter to add a list of the AWS account
ids that are authorized to retore the manual DB snapshot. Uses the
value all
to make the manual DB snapshot public and can
by copied or restored by all AWS accounts. Do not add the
all
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.
modifyDBSnapshotAttribute
in interface AmazonRDS
modifyDBSnapshotAttributeRequest
- Container for the necessary
parameters to execute the ModifyDBSnapshotAttribute service method on
AmazonRDS.InvalidDBSnapshotStateException
SharedSnapshotQuotaExceededException
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeEventCategories
in interface AmazonRDS
describeEventCategoriesRequest
- Container for the necessary
parameters to execute the DescribeEventCategories service method on
AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest)
Copies the specified DB parameter group.
copyDBParameterGroup
in interface AmazonRDS
copyDBParameterGroupRequest
- Container for the necessary
parameters to execute the CopyDBParameterGroup service method on
AmazonRDS.DBParameterGroupNotFoundException
DBParameterGroupQuotaExceededException
DBParameterGroupAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
restoreDBClusterFromSnapshot
in interface AmazonRDS
restoreDBClusterFromSnapshotRequest
- Container for the necessary
parameters to execute the RestoreDBClusterFromSnapshot service method
on AmazonRDS.DBClusterQuotaExceededException
DBSubnetGroupNotFoundException
InvalidVPCNetworkStateException
InvalidDBSnapshotStateException
InvalidSubnetException
DBClusterAlreadyExistsException
DBSnapshotNotFoundException
KMSKeyNotAccessibleException
InsufficientDBClusterCapacityException
InvalidRestoreException
DBClusterSnapshotNotFoundException
StorageQuotaExceededException
InvalidDBClusterSnapshotStateException
InsufficientStorageClusterCapacityException
OptionGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeDBClusters
in interface AmazonRDS
describeDBClustersRequest
- Container for the necessary
parameters to execute the DescribeDBClusters service method on
AmazonRDS.DBClusterNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
rebootDBInstance
in interface AmazonRDS
rebootDBInstanceRequest
- Container for the necessary parameters
to execute the RebootDBInstance service method on AmazonRDS.DBInstanceNotFoundException
InvalidDBInstanceStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
IMPORTANT: The source DB instance must have backup retention enabled.
createDBInstanceReadReplica
in interface AmazonRDS
createDBInstanceReadReplicaRequest
- Container for the necessary
parameters to execute the CreateDBInstanceReadReplica service method
on AmazonRDS.DBParameterGroupNotFoundException
DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
DBInstanceNotFoundException
InvalidVPCNetworkStateException
StorageTypeNotSupportedException
InvalidDBSubnetGroupException
DBSecurityGroupNotFoundException
InvalidSubnetException
KMSKeyNotAccessibleException
InstanceQuotaExceededException
DBSubnetGroupNotAllowedException
StorageQuotaExceededException
InvalidDBInstanceStateException
DBSubnetGroupDoesNotCoverEnoughAZsException
InsufficientDBInstanceCapacityException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE:The DBSnapshot must be in the available state to be deleted.
deleteDBSnapshot
in interface AmazonRDS
deleteDBSnapshotRequest
- Container for the necessary parameters
to execute the DeleteDBSnapshot service method on AmazonRDS.InvalidDBSnapshotStateException
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeEvents
in interface AmazonRDS
describeEventsRequest
- Container for the necessary parameters to
execute the DescribeEvents service method on AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
deleteDBCluster
in interface AmazonRDS
deleteDBClusterRequest
- Container for the necessary parameters
to execute the DeleteDBCluster service method on AmazonRDS.DBClusterNotFoundException
InvalidDBClusterStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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 .
listTagsForResource
in interface AmazonRDS
listTagsForResourceRequest
- Container for the necessary
parameters to execute the ListTagsForResource service method on
AmazonRDS.DBInstanceNotFoundException
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
describeOptionGroupOptions
in interface AmazonRDS
describeOptionGroupOptionsRequest
- Container for the necessary
parameters to execute the DescribeOptionGroupOptions service method on
AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
describeDBParameters
in interface AmazonRDS
describeDBParametersRequest
- Container for the necessary
parameters to execute the DescribeDBParameters service method on
AmazonRDS.DBParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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
, and
ApplyMethod
. 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.
NOTE: 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.
IMPORTANT: 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.
modifyDBClusterParameterGroup
in interface AmazonRDS
modifyDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the ModifyDBClusterParameterGroup
service method on AmazonRDS.DBParameterGroupNotFoundException
InvalidDBParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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 to BackupRetentionPeriod
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.
restoreDBClusterToPointInTime
in interface AmazonRDS
restoreDBClusterToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBClusterToPointInTime
service method on AmazonRDS.DBClusterQuotaExceededException
DBSubnetGroupNotFoundException
InvalidVPCNetworkStateException
InvalidDBSnapshotStateException
InvalidSubnetException
DBClusterAlreadyExistsException
KMSKeyNotAccessibleException
InsufficientDBClusterCapacityException
InvalidRestoreException
DBClusterSnapshotNotFoundException
StorageQuotaExceededException
InvalidDBClusterSnapshotStateException
DBClusterNotFoundException
OptionGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
Purchases a reserved DB instance offering.
purchaseReservedDBInstancesOffering
in interface AmazonRDS
purchaseReservedDBInstancesOfferingRequest
- Container for the
necessary parameters to execute the
PurchaseReservedDBInstancesOffering service method on AmazonRDS.ReservedDBInstancesOfferingNotFoundException
ReservedDBInstanceQuotaExceededException
ReservedDBInstanceAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
Returns a list of DBSecurityGroup
descriptions. If a
DBSecurityGroupName
is specified, the list will contain
only the descriptions of the specified DB security group.
describeDBSecurityGroups
in interface AmazonRDS
describeDBSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSecurityGroups service method on
AmazonRDS.DBSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
modifyEventSubscription
in interface AmazonRDS
modifyEventSubscriptionRequest
- Container for the necessary
parameters to execute the ModifyEventSubscription service method on
AmazonRDS.SNSTopicArnNotFoundException
SNSInvalidTopicException
SubscriptionCategoryNotFoundException
SubscriptionNotFoundException
SNSNoAuthorizationException
EventSubscriptionQuotaExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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".
deleteDBInstance
in interface AmazonRDS
deleteDBInstanceRequest
- Container for the necessary parameters
to execute the DeleteDBInstance service method on AmazonRDS.DBInstanceNotFoundException
InvalidDBInstanceStateException
SnapshotQuotaExceededException
DBSnapshotAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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, but in a system chosen 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 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.
restoreDBInstanceFromDBSnapshot
in interface AmazonRDS
restoreDBInstanceFromDBSnapshotRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
service method on AmazonRDS.DBSubnetGroupNotFoundException
DBInstanceAlreadyExistsException
InvalidVPCNetworkStateException
InvalidDBSnapshotStateException
StorageTypeNotSupportedException
DBSecurityGroupNotFoundException
InvalidSubnetException
AuthorizationNotFoundException
DBSnapshotNotFoundException
KMSKeyNotAccessibleException
InvalidRestoreException
InstanceQuotaExceededException
StorageQuotaExceededException
DBSubnetGroupDoesNotCoverEnoughAZsException
InsufficientDBInstanceCapacityException
OptionGroupNotFoundException
ProvisionedIopsNotAvailableInAZException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
Creates a new option group. You can create up to 20 option groups.
createOptionGroup
in interface AmazonRDS
createOptionGroupRequest
- Container for the necessary parameters
to execute the CreateOptionGroup service method on AmazonRDS.OptionGroupAlreadyExistsException
OptionGroupQuotaExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
Modifies an existing option group.
modifyOptionGroup
in interface AmazonRDS
modifyOptionGroupRequest
- Container for the necessary parameters
to execute the ModifyOptionGroup service method on AmazonRDS.InvalidOptionGroupStateException
OptionGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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 .
describeDBSubnetGroups
in interface AmazonRDS
describeDBSubnetGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSubnetGroups service method on
AmazonRDS.DBSubnetGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
Returns a list of DBParameterGroup
descriptions. If a
DBParameterGroupName
is specified, the list will contain
only the description of the specified DB parameter group.
describeDBParameterGroups
in interface AmazonRDS
describeDBParameterGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBParameterGroups service method on
AmazonRDS.DBParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeEventSubscriptions
in interface AmazonRDS
describeEventSubscriptionsRequest
- Container for the necessary
parameters to execute the DescribeEventSubscriptions service method on
AmazonRDS.SubscriptionNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
modifyDBSubnetGroup
in interface AmazonRDS
modifyDBSubnetGroupRequest
- Container for the necessary
parameters to execute the ModifyDBSubnetGroup service method on
AmazonRDS.DBSubnetGroupNotFoundException
DBSubnetQuotaExceededException
SubnetAlreadyInUseException
DBSubnetGroupDoesNotCoverEnoughAZsException
InvalidSubnetException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeEngineDefaultClusterParameters
in interface AmazonRDS
describeEngineDefaultClusterParametersRequest
- Container for the
necessary parameters to execute the
DescribeEngineDefaultClusterParameters service method on AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
createDBCluster
in interface AmazonRDS
createDBClusterRequest
- Container for the necessary parameters
to execute the CreateDBCluster service method on AmazonRDS.KMSKeyNotAccessibleException
DBClusterQuotaExceededException
DBSubnetGroupNotFoundException
StorageQuotaExceededException
InvalidVPCNetworkStateException
DBClusterParameterGroupNotFoundException
InvalidDBSubnetGroupStateException
InvalidDBClusterStateException
InvalidSubnetException
DBClusterAlreadyExistsException
InsufficientStorageClusterCapacityException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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
and ApplyMethod
.
To reset the entire DB cluster parameter group, specify the
DBClusterParameterGroupName
and
ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated
immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance
restart or RebootDBInstance request. 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.
resetDBClusterParameterGroup
in interface AmazonRDS
resetDBClusterParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBClusterParameterGroup service method
on AmazonRDS.DBParameterGroupNotFoundException
InvalidDBParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
Returns information about DB snapshots. This API supports pagination.
describeDBSnapshots
in interface AmazonRDS
describeDBSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshots service method on
AmazonRDS.DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE: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.
deleteDBClusterSnapshot
in interface AmazonRDS
deleteDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the DeleteDBClusterSnapshot service method on
AmazonRDS.DBClusterSnapshotNotFoundException
InvalidDBClusterSnapshotStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void 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.
deleteDBClusterParameterGroup
in interface AmazonRDS
deleteDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the DeleteDBClusterParameterGroup
service method on AmazonRDS.DBParameterGroupNotFoundException
InvalidDBParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
createDBSubnetGroup
in interface AmazonRDS
createDBSubnetGroupRequest
- Container for the necessary
parameters to execute the CreateDBSubnetGroup service method on
AmazonRDS.DBSubnetQuotaExceededException
DBSubnetGroupAlreadyExistsException
DBSubnetGroupQuotaExceededException
DBSubnetGroupDoesNotCoverEnoughAZsException
InvalidSubnetException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeAccountAttributes
in interface AmazonRDS
describeAccountAttributesRequest
- Container for the necessary
parameters to execute the DescribeAccountAttributes service method on
AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available DB engines.
describeDBEngineVersions
in interface AmazonRDS
describeDBEngineVersionsRequest
- Container for the necessary
parameters to execute the DescribeDBEngineVersions service method on
AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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
, and
ApplyMethod
. A maximum of 20 parameters can be modified
in a single request.
NOTE: 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.
IMPORTANT: 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.
modifyDBParameterGroup
in interface AmazonRDS
modifyDBParameterGroupRequest
- Container for the necessary
parameters to execute the ModifyDBParameterGroup service method on
AmazonRDS.DBParameterGroupNotFoundException
InvalidDBParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParameters
in interface AmazonRDS
describeEngineDefaultParametersRequest
- Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
service method on AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
createDBClusterSnapshot
in interface AmazonRDS
createDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the CreateDBClusterSnapshot service method on
AmazonRDS.DBClusterNotFoundException
InvalidDBClusterStateException
DBClusterSnapshotAlreadyExistsException
SnapshotQuotaExceededException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest)
Creates a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshot
in interface AmazonRDS
createDBSnapshotRequest
- Container for the necessary parameters
to execute the CreateDBSnapshot service method on AmazonRDS.DBInstanceNotFoundException
InvalidDBInstanceStateException
SnapshotQuotaExceededException
DBSnapshotAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscription
in interface AmazonRDS
addSourceIdentifierToSubscriptionRequest
- Container for the
necessary parameters to execute the AddSourceIdentifierToSubscription
service method on AmazonRDS.SourceNotFoundException
SubscriptionNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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
and ApplyMethod
.
To reset the entire DB parameter group, specify the
DBParameterGroup
name and ResetAllParameters
parameters. When resetting the entire group, dynamic parameters are
updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance
restart or RebootDBInstance
request.
resetDBParameterGroup
in interface AmazonRDS
resetDBParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBParameterGroup service method on
AmazonRDS.DBParameterGroupNotFoundException
InvalidDBParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
deleteDBParameterGroup
in interface AmazonRDS
deleteDBParameterGroupRequest
- Container for the necessary
parameters to execute the DeleteDBParameterGroup service method on
AmazonRDS.DBParameterGroupNotFoundException
InvalidDBParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)
Returns a list of DB log files for the DB instance.
describeDBLogFiles
in interface AmazonRDS
describeDBLogFilesRequest
- Container for the necessary
parameters to execute the DescribeDBLogFiles service method on
AmazonRDS.DBInstanceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstances
in interface AmazonRDS
describeReservedDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeReservedDBInstances service method
on AmazonRDS.ReservedDBInstanceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
failoverDBCluster
in interface AmazonRDS
failoverDBClusterRequest
- Container for the necessary parameters
to execute the FailoverDBCluster service method on AmazonRDS.DBClusterNotFoundException
InvalidDBClusterStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)
Promotes a Read Replica DB instance to a standalone DB instance.
NOTE: 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.
promoteReadReplica
in interface AmazonRDS
promoteReadReplicaRequest
- Container for the necessary
parameters to execute the PromoteReadReplica service method on
AmazonRDS.DBInstanceNotFoundException
InvalidDBInstanceStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void 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 .
addTagsToResource
in interface AmazonRDS
addTagsToResourceRequest
- Container for the necessary parameters
to execute the AddTagsToResource service method on AmazonRDS.DBInstanceNotFoundException
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
modifyDBCluster
in interface AmazonRDS
modifyDBClusterRequest
- Container for the necessary parameters
to execute the ModifyDBCluster service method on AmazonRDS.DBSubnetGroupNotFoundException
StorageQuotaExceededException
InvalidVPCNetworkStateException
DBClusterParameterGroupNotFoundException
InvalidDBSubnetGroupStateException
DBClusterNotFoundException
InvalidDBInstanceStateException
InvalidDBClusterStateException
InvalidDBSecurityGroupStateException
InvalidSubnetException
DBClusterAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
copyDBClusterSnapshot
in interface AmazonRDS
copyDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the CopyDBClusterSnapshot service method on
AmazonRDS.DBClusterSnapshotNotFoundException
InvalidDBClusterStateException
DBClusterSnapshotAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
Downloads all or a portion of the specified log file, up to 1 MB in size.
downloadDBLogFilePortion
in interface AmazonRDS
downloadDBLogFilePortionRequest
- Container for the necessary
parameters to execute the DownloadDBLogFilePortion service method on
AmazonRDS.DBLogFileNotFoundException
DBInstanceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
createEventSubscription
in interface AmazonRDS
createEventSubscriptionRequest
- Container for the necessary
parameters to execute the CreateEventSubscription service method on
AmazonRDS.SourceNotFoundException
SNSTopicArnNotFoundException
SNSInvalidTopicException
SubscriptionCategoryNotFoundException
SNSNoAuthorizationException
EventSubscriptionQuotaExceededException
SubscriptionAlreadyExistException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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).
revokeDBSecurityGroupIngress
in interface AmazonRDS
revokeDBSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeDBSecurityGroupIngress service method
on AmazonRDS.DBSecurityGroupNotFoundException
InvalidDBSecurityGroupStateException
AuthorizationNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificates
in interface AmazonRDS
describeCertificatesRequest
- Container for the necessary
parameters to execute the DescribeCertificates service method on
AmazonRDS.CertificateNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
IMPORTANT: 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.
createDBParameterGroup
in interface AmazonRDS
createDBParameterGroupRequest
- Container for the necessary
parameters to execute the CreateDBParameterGroup service method on
AmazonRDS.DBParameterGroupQuotaExceededException
DBParameterGroupAlreadyExistsException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptions
in interface AmazonRDS
describeOrderableDBInstanceOptionsRequest
- Container for the
necessary parameters to execute the DescribeOrderableDBInstanceOptions
service method on AmazonRDS.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public void deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
Deletes an existing option group.
deleteOptionGroup
in interface AmazonRDS
deleteOptionGroupRequest
- Container for the necessary parameters
to execute the DeleteOptionGroup service method on AmazonRDS.InvalidOptionGroupStateException
OptionGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferings
in interface AmazonRDS
describeReservedDBInstancesOfferingsRequest
- Container for the
necessary parameters to execute the
DescribeReservedDBInstancesOfferings service method on AmazonRDS.ReservedDBInstancesOfferingNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions() throws AmazonServiceException, AmazonClientException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActions
in interface AmazonRDS
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeOptionGroupsResult describeOptionGroups() throws AmazonServiceException, AmazonClientException
Describes the available option groups.
describeOptionGroups
in interface AmazonRDS
OptionGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBInstancesResult describeDBInstances() throws AmazonServiceException, AmazonClientException
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstances
in interface AmazonRDS
DBInstanceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups() throws AmazonServiceException, AmazonClientException
Returns a list of DBClusterParameterGroup
descriptions.
If a DBClusterParameterGroupName
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.
describeDBClusterParameterGroups
in interface AmazonRDS
DBParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBSnapshotAttributesResult describeDBSnapshotAttributes() throws AmazonServiceException, AmazonClientException
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts,
DescribeDBSnapshotAttributes
returns the
restore
attribute and a list of the AWS account ids that
are authorized to copy or restore the manual DB snapshot. If
all
is included in the list of values for the
restore
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.
describeDBSnapshotAttributes
in interface AmazonRDS
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots() throws AmazonServiceException, AmazonClientException
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.
describeDBClusterSnapshots
in interface AmazonRDS
DBClusterSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeEventCategoriesResult describeEventCategories() throws AmazonServiceException, AmazonClientException
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
describeEventCategories
in interface AmazonRDS
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBClustersResult describeDBClusters() throws AmazonServiceException, AmazonClientException
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.
describeDBClusters
in interface AmazonRDS
DBClusterNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeEventsResult describeEvents() throws AmazonServiceException, AmazonClientException
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEvents
in interface AmazonRDS
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBSecurityGroupsResult describeDBSecurityGroups() throws AmazonServiceException, AmazonClientException
Returns a list of DBSecurityGroup
descriptions. If a
DBSecurityGroupName
is specified, the list will contain
only the descriptions of the specified DB security group.
describeDBSecurityGroups
in interface AmazonRDS
DBSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBSubnetGroupsResult describeDBSubnetGroups() throws AmazonServiceException, AmazonClientException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial .
describeDBSubnetGroups
in interface AmazonRDS
DBSubnetGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBParameterGroupsResult describeDBParameterGroups() throws AmazonServiceException, AmazonClientException
Returns a list of DBParameterGroup
descriptions. If a
DBParameterGroupName
is specified, the list will contain
only the description of the specified DB parameter group.
describeDBParameterGroups
in interface AmazonRDS
DBParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeEventSubscriptionsResult describeEventSubscriptions() throws AmazonServiceException, AmazonClientException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptions
in interface AmazonRDS
SubscriptionNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBSnapshotsResult describeDBSnapshots() throws AmazonServiceException, AmazonClientException
Returns information about DB snapshots. This API supports pagination.
describeDBSnapshots
in interface AmazonRDS
DBSnapshotNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeAccountAttributesResult describeAccountAttributes() throws AmazonServiceException, AmazonClientException
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.
describeAccountAttributes
in interface AmazonRDS
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeDBEngineVersionsResult describeDBEngineVersions() throws AmazonServiceException, AmazonClientException
Returns a list of the available DB engines.
describeDBEngineVersions
in interface AmazonRDS
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedDBInstancesResult describeReservedDBInstances() throws AmazonServiceException, AmazonClientException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstances
in interface AmazonRDS
ReservedDBInstanceNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DBCluster failoverDBCluster() throws AmazonServiceException, AmazonClientException
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.
failoverDBCluster
in interface AmazonRDS
DBClusterNotFoundException
InvalidDBClusterStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeCertificatesResult describeCertificates() throws AmazonServiceException, AmazonClientException
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificates
in interface AmazonRDS
CertificateNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings() throws AmazonServiceException, AmazonClientException
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferings
in interface AmazonRDS
ReservedDBInstancesOfferingNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonRDS
request
- The originally executed requestCopyright © 2015. All rights reserved.