@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonRDSClient extends AmazonWebServiceClient implements AmazonRDS
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, 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, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonRDSClient()
Deprecated.
|
AmazonRDSClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonRDSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonRDSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonRDSClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddRoleToDBClusterResult |
addRoleToDBCluster(AddRoleToDBClusterRequest request)
Associates an Identity and Access Management (IAM) role with a DB cluster.
|
AddRoleToDBInstanceResult |
addRoleToDBInstance(AddRoleToDBInstanceRequest request)
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
|
EventSubscription |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
Adds a source identifier to an existing RDS event notification subscription.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds metadata tags to an Amazon RDS resource.
|
ResourcePendingMaintenanceActions |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
DBSecurityGroup |
authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest request)
Enables ingress to a DBSecurityGroup using one of two forms of authorization.
|
BacktrackDBClusterResult |
backtrackDBCluster(BacktrackDBClusterRequest request)
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
|
static AmazonRDSClientBuilder |
builder() |
CancelExportTaskResult |
cancelExportTask(CancelExportTaskRequest request)
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.
|
DBClusterParameterGroup |
copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
Copies the specified DB cluster parameter group.
|
DBClusterSnapshot |
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
Copies a snapshot of a DB cluster.
|
DBParameterGroup |
copyDBParameterGroup(CopyDBParameterGroupRequest request)
Copies the specified DB parameter group.
|
DBSnapshot |
copyDBSnapshot(CopyDBSnapshotRequest request)
Copies the specified DB snapshot.
|
OptionGroup |
copyOptionGroup(CopyOptionGroupRequest request)
Copies the specified option group.
|
CreateBlueGreenDeploymentResult |
createBlueGreenDeployment(CreateBlueGreenDeploymentRequest request)
Creates a blue/green deployment.
|
CreateCustomDBEngineVersionResult |
createCustomDBEngineVersion(CreateCustomDBEngineVersionRequest request)
Creates a custom DB engine version (CEV).
|
DBCluster |
createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
CreateDBClusterEndpointResult |
createDBClusterEndpoint(CreateDBClusterEndpointRequest request)
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
|
DBClusterParameterGroup |
createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
Creates a new DB cluster parameter group.
|
DBClusterSnapshot |
createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
Creates a snapshot of a DB cluster.
|
DBInstance |
createDBInstance(CreateDBInstanceRequest request)
Creates a new DB instance.
|
DBInstance |
createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest request)
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.
|
DBParameterGroup |
createDBParameterGroup(CreateDBParameterGroupRequest request)
Creates a new DB parameter group.
|
CreateDBProxyResult |
createDBProxy(CreateDBProxyRequest request)
Creates a new DB proxy.
|
CreateDBProxyEndpointResult |
createDBProxyEndpoint(CreateDBProxyEndpointRequest request)
Creates a
DBProxyEndpoint . |
DBSecurityGroup |
createDBSecurityGroup(CreateDBSecurityGroupRequest request)
Creates a new DB security group.
|
CreateDBShardGroupResult |
createDBShardGroup(CreateDBShardGroupRequest request)
Creates a new DB shard group for Aurora Limitless Database.
|
DBSnapshot |
createDBSnapshot(CreateDBSnapshotRequest request)
Creates a snapshot of a DB instance.
|
DBSubnetGroup |
createDBSubnetGroup(CreateDBSubnetGroupRequest request)
Creates a new DB subnet group.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an RDS event notification subscription.
|
GlobalCluster |
createGlobalCluster(CreateGlobalClusterRequest request)
Creates an Aurora global database spread across multiple Amazon Web Services Regions.
|
CreateIntegrationResult |
createIntegration(CreateIntegrationRequest request)
Creates a zero-ETL integration with Amazon Redshift.
|
OptionGroup |
createOptionGroup(CreateOptionGroupRequest request)
Creates a new option group.
|
TenantDatabase |
createTenantDatabase(CreateTenantDatabaseRequest request)
Creates a tenant database in a DB instance that uses the multi-tenant configuration.
|
DeleteBlueGreenDeploymentResult |
deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request)
Deletes a blue/green deployment.
|
DeleteCustomDBEngineVersionResult |
deleteCustomDBEngineVersion(DeleteCustomDBEngineVersionRequest request)
Deletes a custom engine version.
|
DBCluster |
deleteDBCluster(DeleteDBClusterRequest request)
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
DBClusterAutomatedBackup |
deleteDBClusterAutomatedBackup(DeleteDBClusterAutomatedBackupRequest request)
Deletes automated backups using the
DbClusterResourceId value of the source DB cluster or the Amazon
Resource Name (ARN) of the automated backups. |
DeleteDBClusterEndpointResult |
deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest request)
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
|
DeleteDBClusterParameterGroupResult |
deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
Deletes a specified DB cluster parameter group.
|
DBClusterSnapshot |
deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
Deletes a DB cluster snapshot.
|
DBInstance |
deleteDBInstance(DeleteDBInstanceRequest request)
Deletes a previously provisioned DB instance.
|
DBInstanceAutomatedBackup |
deleteDBInstanceAutomatedBackup(DeleteDBInstanceAutomatedBackupRequest request)
Deletes automated backups using the
DbiResourceId value of the source DB instance or the Amazon
Resource Name (ARN) of the automated backups. |
DeleteDBParameterGroupResult |
deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Deletes a specified DB parameter group.
|
DeleteDBProxyResult |
deleteDBProxy(DeleteDBProxyRequest request)
Deletes an existing DB proxy.
|
DeleteDBProxyEndpointResult |
deleteDBProxyEndpoint(DeleteDBProxyEndpointRequest request)
Deletes a
DBProxyEndpoint . |
DeleteDBSecurityGroupResult |
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
Deletes a DB security group.
|
DeleteDBShardGroupResult |
deleteDBShardGroup(DeleteDBShardGroupRequest request)
Deletes an Aurora Limitless Database DB shard group.
|
DBSnapshot |
deleteDBSnapshot(DeleteDBSnapshotRequest request)
Deletes a DB snapshot.
|
DeleteDBSubnetGroupResult |
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
Deletes a DB subnet group.
|
EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an RDS event notification subscription.
|
GlobalCluster |
deleteGlobalCluster(DeleteGlobalClusterRequest request)
Deletes a global database cluster.
|
DeleteIntegrationResult |
deleteIntegration(DeleteIntegrationRequest request)
Deletes a zero-ETL integration with Amazon Redshift.
|
DeleteOptionGroupResult |
deleteOptionGroup(DeleteOptionGroupRequest request)
Deletes an existing option group.
|
TenantDatabase |
deleteTenantDatabase(DeleteTenantDatabaseRequest request)
Deletes a tenant database from your DB instance.
|
DeregisterDBProxyTargetsResult |
deregisterDBProxyTargets(DeregisterDBProxyTargetsRequest request)
Remove the association between one or more
DBProxyTarget data structures and a
DBProxyTargetGroup . |
DescribeAccountAttributesResult |
describeAccountAttributes()
Simplified method form for invoking the DescribeAccountAttributes operation.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest request)
Lists all of the attributes for a customer account.
|
DescribeBlueGreenDeploymentsResult |
describeBlueGreenDeployments(DescribeBlueGreenDeploymentsRequest request)
Describes one or more blue/green deployments.
|
DescribeCertificatesResult |
describeCertificates()
Simplified method form for invoking the DescribeCertificates operation.
|
DescribeCertificatesResult |
describeCertificates(DescribeCertificatesRequest request)
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services
account.
|
DescribeDBClusterAutomatedBackupsResult |
describeDBClusterAutomatedBackups(DescribeDBClusterAutomatedBackupsRequest request)
Displays backups for both current and deleted DB clusters.
|
DescribeDBClusterBacktracksResult |
describeDBClusterBacktracks(DescribeDBClusterBacktracksRequest request)
Returns information about backtracks for a DB cluster.
|
DescribeDBClusterEndpointsResult |
describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest request)
Returns information about endpoints for an Amazon Aurora DB cluster.
|
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups()
Simplified method form for invoking the DescribeDBClusterParameterGroups operation.
|
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
Returns a list of
DBClusterParameterGroup descriptions. |
DescribeDBClusterParametersResult |
describeDBClusterParameters(DescribeDBClusterParametersRequest request)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
DescribeDBClustersResult |
describeDBClusters()
Simplified method form for invoking the DescribeDBClusters operation.
|
DescribeDBClustersResult |
describeDBClusters(DescribeDBClustersRequest request)
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.
|
DBClusterSnapshotAttributesResult |
describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
DescribeDBClusterSnapshotsResult |
describeDBClusterSnapshots()
Simplified method form for invoking the DescribeDBClusterSnapshots operation.
|
DescribeDBClusterSnapshotsResult |
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
Returns information about DB cluster snapshots.
|
DescribeDBEngineVersionsResult |
describeDBEngineVersions()
Simplified method form for invoking the DescribeDBEngineVersions operation.
|
DescribeDBEngineVersionsResult |
describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
Describes the properties of specific versions of DB engines.
|
DescribeDBInstanceAutomatedBackupsResult |
describeDBInstanceAutomatedBackups(DescribeDBInstanceAutomatedBackupsRequest request)
Displays backups for both current and deleted instances.
|
DescribeDBInstancesResult |
describeDBInstances()
Simplified method form for invoking the DescribeDBInstances operation.
|
DescribeDBInstancesResult |
describeDBInstances(DescribeDBInstancesRequest request)
Describes provisioned RDS instances.
|
DescribeDBLogFilesResult |
describeDBLogFiles(DescribeDBLogFilesRequest request)
Returns a list of DB log files for the DB instance.
|
DescribeDBParameterGroupsResult |
describeDBParameterGroups()
Simplified method form for invoking the DescribeDBParameterGroups operation.
|
DescribeDBParameterGroupsResult |
describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
Returns a list of
DBParameterGroup descriptions. |
DescribeDBParametersResult |
describeDBParameters(DescribeDBParametersRequest request)
Returns the detailed parameter list for a particular DB parameter group.
|
DescribeDBProxiesResult |
describeDBProxies(DescribeDBProxiesRequest request)
Returns information about DB proxies.
|
DescribeDBProxyEndpointsResult |
describeDBProxyEndpoints(DescribeDBProxyEndpointsRequest request)
Returns information about DB proxy endpoints.
|
DescribeDBProxyTargetGroupsResult |
describeDBProxyTargetGroups(DescribeDBProxyTargetGroupsRequest request)
Returns information about DB proxy target groups, represented by
DBProxyTargetGroup data structures. |
DescribeDBProxyTargetsResult |
describeDBProxyTargets(DescribeDBProxyTargetsRequest request)
Returns information about
DBProxyTarget objects. |
DescribeDBRecommendationsResult |
describeDBRecommendations(DescribeDBRecommendationsRequest request)
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
|
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups()
Simplified method form for invoking the DescribeDBSecurityGroups operation.
|
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest request)
Returns a list of
DBSecurityGroup descriptions. |
DescribeDBShardGroupsResult |
describeDBShardGroups(DescribeDBShardGroupsRequest request)
Describes existing Aurora Limitless Database DB shard groups.
|
DBSnapshotAttributesResult |
describeDBSnapshotAttributes()
Simplified method form for invoking the DescribeDBSnapshotAttributes operation.
|
DBSnapshotAttributesResult |
describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest request)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
|
DescribeDBSnapshotsResult |
describeDBSnapshots()
Simplified method form for invoking the DescribeDBSnapshots operation.
|
DescribeDBSnapshotsResult |
describeDBSnapshots(DescribeDBSnapshotsRequest request)
Returns information about DB snapshots.
|
DescribeDBSnapshotTenantDatabasesResult |
describeDBSnapshotTenantDatabases(DescribeDBSnapshotTenantDatabasesRequest request)
Describes the tenant databases that exist in a DB snapshot.
|
DescribeDBSubnetGroupsResult |
describeDBSubnetGroups()
Simplified method form for invoking the DescribeDBSubnetGroups operation.
|
DescribeDBSubnetGroupsResult |
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
Returns a list of DBSubnetGroup descriptions.
|
EngineDefaults |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
Returns the default engine and system parameter information for the cluster database engine.
|
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Returns the default engine and system parameter information for the specified database engine.
|
DescribeEventCategoriesResult |
describeEventCategories()
Simplified method form for invoking the DescribeEventCategories operation.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB
cluster snapshots, and RDS Proxies for the past 14 days.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions()
Simplified method form for invoking the DescribeEventSubscriptions operation.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists all the subscription descriptions for a customer account.
|
DescribeExportTasksResult |
describeExportTasks(DescribeExportTasksRequest request)
Returns information about a snapshot or cluster export to Amazon S3.
|
DescribeGlobalClustersResult |
describeGlobalClusters(DescribeGlobalClustersRequest request)
Returns information about Aurora global database clusters.
|
DescribeIntegrationsResult |
describeIntegrations(DescribeIntegrationsRequest request)
Describe one or more zero-ETL integrations with Amazon Redshift.
|
DescribeOptionGroupOptionsResult |
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
Describes all available options for the specified engine.
|
DescribeOptionGroupsResult |
describeOptionGroups()
Simplified method form for invoking the DescribeOptionGroups operation.
|
DescribeOptionGroupsResult |
describeOptionGroups(DescribeOptionGroupsRequest request)
Describes the available option groups.
|
DescribeOrderableDBInstanceOptionsResult |
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
Describes the orderable DB instance options for a specified DB engine.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions()
Simplified method form for invoking the DescribePendingMaintenanceActions operation.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
DescribeReservedDBInstancesResult |
describeReservedDBInstances()
Simplified method form for invoking the DescribeReservedDBInstances operation.
|
DescribeReservedDBInstancesResult |
describeReservedDBInstances(DescribeReservedDBInstancesRequest request)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
DescribeReservedDBInstancesOfferingsResult |
describeReservedDBInstancesOfferings()
Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.
|
DescribeReservedDBInstancesOfferingsResult |
describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest request)
Lists available reserved DB instance offerings.
|
DescribeSourceRegionsResult |
describeSourceRegions(DescribeSourceRegionsRequest request)
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create
a read replica, copy a DB snapshot from, or replicate automated backups from.
|
DescribeTenantDatabasesResult |
describeTenantDatabases(DescribeTenantDatabasesRequest request)
Describes the tenant databases in a DB instance that uses the multi-tenant configuration.
|
ValidDBInstanceModificationsMessage |
describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
You can call
DescribeValidDBInstanceModifications to learn what modifications you can make to your
DB instance. |
DisableHttpEndpointResult |
disableHttpEndpoint(DisableHttpEndpointRequest request)
Disables the HTTP endpoint for the specified DB cluster.
|
DownloadDBLogFilePortionResult |
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
Downloads all or a portion of the specified log file, up to 1 MB in size.
|
EnableHttpEndpointResult |
enableHttpEndpoint(EnableHttpEndpointRequest request)
Enables the HTTP endpoint for the DB cluster.
|
DBCluster |
failoverDBCluster()
Simplified method form for invoking the FailoverDBCluster operation.
|
DBCluster |
failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.
|
GlobalCluster |
failoverGlobalCluster(FailoverGlobalClusterRequest request)
Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail
over or switch over a global database.
|
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 request)
Lists all tags on an Amazon RDS resource.
|
ModifyActivityStreamResult |
modifyActivityStream(ModifyActivityStreamRequest request)
Changes the audit policy state of a database activity stream to either locked (default) or unlocked.
|
Certificate |
modifyCertificates(ModifyCertificatesRequest request)
Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS
for new DB instances, or remove the override.
|
ModifyCurrentDBClusterCapacityResult |
modifyCurrentDBClusterCapacity(ModifyCurrentDBClusterCapacityRequest request)
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
|
ModifyCustomDBEngineVersionResult |
modifyCustomDBEngineVersion(ModifyCustomDBEngineVersionRequest request)
Modifies the status of a custom engine version (CEV).
|
DBCluster |
modifyDBCluster(ModifyDBClusterRequest request)
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
|
ModifyDBClusterEndpointResult |
modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest request)
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
|
ModifyDBClusterParameterGroupResult |
modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
Modifies the parameters of a DB cluster parameter group.
|
DBClusterSnapshotAttributesResult |
modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
DBInstance |
modifyDBInstance(ModifyDBInstanceRequest request)
Modifies settings for a DB instance.
|
ModifyDBParameterGroupResult |
modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group.
|
ModifyDBProxyResult |
modifyDBProxy(ModifyDBProxyRequest request)
Changes the settings for an existing DB proxy.
|
ModifyDBProxyEndpointResult |
modifyDBProxyEndpoint(ModifyDBProxyEndpointRequest request)
Changes the settings for an existing DB proxy endpoint.
|
ModifyDBProxyTargetGroupResult |
modifyDBProxyTargetGroup(ModifyDBProxyTargetGroupRequest request)
Modifies the properties of a
DBProxyTargetGroup . |
ModifyDBRecommendationResult |
modifyDBRecommendation(ModifyDBRecommendationRequest request)
Updates the recommendation status and recommended action status for the specified recommendation.
|
ModifyDBShardGroupResult |
modifyDBShardGroup(ModifyDBShardGroupRequest request)
Modifies the settings of an Aurora Limitless Database DB shard group.
|
DBSnapshot |
modifyDBSnapshot(ModifyDBSnapshotRequest request)
Updates a manual DB snapshot with a new engine version.
|
DBSnapshotAttributesResult |
modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest request)
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
|
DBSubnetGroup |
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
Modifies an existing DB subnet group.
|
EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing RDS event notification subscription.
|
GlobalCluster |
modifyGlobalCluster(ModifyGlobalClusterRequest request)
Modifies a setting for an Amazon Aurora global database cluster.
|
ModifyIntegrationResult |
modifyIntegration(ModifyIntegrationRequest request)
Modifies a zero-ETL integration with Amazon Redshift.
|
OptionGroup |
modifyOptionGroup(ModifyOptionGroupRequest request)
Modifies an existing option group.
|
TenantDatabase |
modifyTenantDatabase(ModifyTenantDatabaseRequest request)
Modifies an existing tenant database in a DB instance.
|
DBInstance |
promoteReadReplica(PromoteReadReplicaRequest request)
Promotes a read replica DB instance to a standalone DB instance.
|
DBCluster |
promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
Promotes a read replica DB cluster to a standalone DB cluster.
|
ReservedDBInstance |
purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)
Purchases a reserved DB instance offering.
|
DBCluster |
rebootDBCluster(RebootDBClusterRequest request)
You might need to reboot your DB cluster, usually for maintenance reasons.
|
DBInstance |
rebootDBInstance(RebootDBInstanceRequest request)
You might need to reboot your DB instance, usually for maintenance reasons.
|
RebootDBShardGroupResult |
rebootDBShardGroup(RebootDBShardGroupRequest request)
You might need to reboot your DB shard group, usually for maintenance reasons.
|
RegisterDBProxyTargetsResult |
registerDBProxyTargets(RegisterDBProxyTargetsRequest request)
Associate one or more
DBProxyTarget data structures with a DBProxyTargetGroup . |
GlobalCluster |
removeFromGlobalCluster(RemoveFromGlobalClusterRequest request)
Detaches an Aurora secondary cluster from an Aurora global database cluster.
|
RemoveRoleFromDBClusterResult |
removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
|
RemoveRoleFromDBInstanceResult |
removeRoleFromDBInstance(RemoveRoleFromDBInstanceRequest request)
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
|
EventSubscription |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
Removes a source identifier from an existing RDS event notification subscription.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from an Amazon RDS resource.
|
ResetDBClusterParameterGroupResult |
resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
Modifies the parameters of a DB cluster parameter group to the default value.
|
ResetDBParameterGroupResult |
resetDBParameterGroup(ResetDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group to the engine/system default value.
|
DBCluster |
restoreDBClusterFromS3(RestoreDBClusterFromS3Request request)
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.
|
DBCluster |
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
DBCluster |
restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
Restores a DB cluster to an arbitrary point in time.
|
DBInstance |
restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest request)
Creates a new DB instance from a DB snapshot.
|
DBInstance |
restoreDBInstanceFromS3(RestoreDBInstanceFromS3Request request)
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.
|
DBInstance |
restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest request)
Restores a DB instance to an arbitrary point in time.
|
DBSecurityGroup |
revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest request)
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartActivityStreamResult |
startActivityStream(StartActivityStreamRequest request)
Starts a database activity stream to monitor activity on the database.
|
DBCluster |
startDBCluster(StartDBClusterRequest request)
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
CLI command, or the
StopDBCluster operation. |
DBInstance |
startDBInstance(StartDBInstanceRequest request)
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI
command, or the
StopDBInstance operation. |
DBInstanceAutomatedBackup |
startDBInstanceAutomatedBackupsReplication(StartDBInstanceAutomatedBackupsReplicationRequest request)
Enables replication of automated backups to a different Amazon Web Services Region.
|
StartExportTaskResult |
startExportTask(StartExportTaskRequest request)
Starts an export of DB snapshot or DB cluster data to Amazon S3.
|
StopActivityStreamResult |
stopActivityStream(StopActivityStreamRequest request)
Stops a database activity stream that was started using the Amazon Web Services console, the
start-activity-stream CLI command, or the StartActivityStream operation. |
DBCluster |
stopDBCluster(StopDBClusterRequest request)
Stops an Amazon Aurora DB cluster.
|
DBInstance |
stopDBInstance(StopDBInstanceRequest request)
Stops an Amazon RDS DB instance.
|
DBInstanceAutomatedBackup |
stopDBInstanceAutomatedBackupsReplication(StopDBInstanceAutomatedBackupsReplicationRequest request)
Stops automated backup replication for a DB instance.
|
SwitchoverBlueGreenDeploymentResult |
switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request)
Switches over a blue/green deployment.
|
GlobalCluster |
switchoverGlobalCluster(SwitchoverGlobalClusterRequest request)
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.
|
DBInstance |
switchoverReadReplica(SwitchoverReadReplicaRequest request)
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database.
|
AmazonRDSWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonRDSClient()
AmazonRDSClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonRDSClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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 Amazon RDS (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonRDSClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonRDSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AmazonRDSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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 Amazon RDS (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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 Amazon RDS (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 Amazon RDS (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonRDSClientBuilder builder()
public AddRoleToDBClusterResult addRoleToDBCluster(AddRoleToDBClusterRequest request)
Associates an Identity and Access Management (IAM) role with a DB cluster.
addRoleToDBCluster
in interface AmazonRDS
addRoleToDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBClusterRoleAlreadyExistsException
- The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBClusterRoleQuotaExceededException
- You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.public AddRoleToDBInstanceResult addRoleToDBInstance(AddRoleToDBInstanceRequest request)
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available
.
This command doesn't apply to RDS Custom.
addRoleToDBInstance
in interface AmazonRDS
addRoleToDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBInstanceRoleAlreadyExistsException
- The specified RoleArn
or FeatureName
value is already associated with the DB
instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBInstanceRoleQuotaExceededException
- You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB
instance because the quota has been reached.public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscription
in interface AmazonRDS
addSourceIdentifierToSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); AddSourceIdentifierToSubscriptionRequest request = new AddSourceIdentifierToSubscriptionRequest().withSubscriptionName("mymysqleventsubscription") .withSourceIdentifier("mymysqlinstance"); EventSubscription response = client.addSourceIdentifierToSubscription(request);
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
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 your relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora and Amazon RDS Resources.
addTagsToResource
in interface AmazonRDS
addTagsToResourceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.IntegrationNotFoundException
- The specified integration could not be found.TenantDatabaseNotFoundException
- The specified tenant database wasn't found in the DB instance.DBSnapshotTenantDatabaseNotFoundException
- The specified snapshot tenant database wasn't found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); AddTagsToResourceRequest request = new AddTagsToResourceRequest().withResourceName("arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup") .withTags(new Tag().withKey("Staging").withValue("LocationDB")); AddTagsToResourceResult response = client.addTagsToResource(request);
public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceAction
in interface AmazonRDS
applyPendingMaintenanceActionRequest
- ResourceNotFoundException
- The specified resource ID was not found.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ApplyPendingMaintenanceActionRequest request = new ApplyPendingMaintenanceActionRequest() .withResourceIdentifier("arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance").withApplyAction("system-update").withOptInType("immediate"); ResourcePendingMaintenanceActions response = client.applyPendingMaintenanceAction(request);
public DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest request)
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't 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.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
authorizeDBSecurityGroupIngress
in interface AmazonRDS
authorizeDBSecurityGroupIngressRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InvalidDBSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.AuthorizationAlreadyExistsException
- The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB
security group.AuthorizationQuotaExceededException
- The DB security group authorization quota has been reached.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); AuthorizeDBSecurityGroupIngressRequest request = new AuthorizeDBSecurityGroupIngressRequest().withDBSecurityGroupName("mydbsecuritygroup").withCIDRIP( "203.0.113.5/32"); DBSecurityGroup response = client.authorizeDBSecurityGroupIngress(request);
public BacktrackDBClusterResult backtrackDBCluster(BacktrackDBClusterRequest request)
Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action applies only to Aurora MySQL DB clusters.
backtrackDBCluster
in interface AmazonRDS
backtrackDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
cancelExportTask
in interface AmazonRDS
cancelExportTaskRequest
- ExportTaskNotFoundException
- The export task doesn't exist.InvalidExportTaskStateException
- You can't cancel an export task that has completed.public DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
Copies the specified DB cluster parameter group.
You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
copyDBClusterParameterGroup
in interface AmazonRDS
copyDBClusterParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CopyDBClusterParameterGroupRequest request = new CopyDBClusterParameterGroupRequest() .withSourceDBClusterParameterGroupIdentifier("mydbclusterparametergroup") .withTargetDBClusterParameterGroupIdentifier("mydbclusterparametergroup-copy") .withTargetDBClusterParameterGroupDescription("My DB cluster parameter group copy"); DBClusterParameterGroup response = client.copyDBClusterParameterGroup(request);
public DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster
snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon
Web Services Region where you call the CopyDBClusterSnapshot
operation is the destination Amazon Web
Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot
from another Amazon Web Services Region, you must provide the following values:
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier
for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is
the same value as the SourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
copyDBClusterSnapshot
in interface AmazonRDS
copyDBClusterSnapshotRequest
- DBClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CopyDBClusterSnapshotRequest request = new CopyDBClusterSnapshotRequest().withSourceDBClusterSnapshotIdentifier("rds:sample-cluster-2016-09-14-10-38") .withTargetDBClusterSnapshotIdentifier("cluster-snapshot-copy-1"); DBClusterSnapshot response = client.copyDBClusterSnapshot(request);
public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest request)
Copies the specified DB parameter group.
You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.
copyDBParameterGroup
in interface AmazonRDS
copyDBParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.DBParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CopyDBParameterGroupRequest request = new CopyDBParameterGroupRequest().withSourceDBParameterGroupIdentifier("mymysqlparametergroup") .withTargetDBParameterGroupIdentifier("mymysqlparametergroup-copy").withTargetDBParameterGroupDescription("My MySQL parameter group copy"); DBParameterGroup response = client.copyDBParameterGroup(request);
public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest request)
Copies the specified DB snapshot. The source DB snapshot must be in the available
state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services
Region where you call the CopyDBSnapshot
operation is the destination Amazon Web Services Region for
the DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
copyDBSnapshot
in interface AmazonRDS
copyDBSnapshotRequest
- DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.CustomAvailabilityZoneNotFoundException
- CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CopyDBSnapshotRequest request = new CopyDBSnapshotRequest().withSourceDBSnapshotIdentifier("mydbsnapshot").withTargetDBSnapshotIdentifier( "mydbsnapshot-copy"); DBSnapshot response = client.copyDBSnapshot(request);
public OptionGroup copyOptionGroup(CopyOptionGroupRequest request)
Copies the specified option group.
copyOptionGroup
in interface AmazonRDS
copyOptionGroupRequest
- OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupNotFoundException
- The specified option group could not be found.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this Amazon Web Services account.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CopyOptionGroupRequest request = new CopyOptionGroupRequest().withSourceOptionGroupIdentifier("mymysqloptiongroup") .withTargetOptionGroupIdentifier("mymysqloptiongroup-copy").withTargetOptionGroupDescription("My MySQL option group copy"); OptionGroup response = client.copyOptionGroup(request);
public CreateBlueGreenDeploymentResult createBlueGreenDeployment(CreateBlueGreenDeploymentRequest request)
Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
createBlueGreenDeployment
in interface AmazonRDS
createBlueGreenDeploymentRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SourceDatabaseNotSupportedException
- The source DB instance isn't supported for a blue/green deployment.SourceClusterNotSupportedException
- The source DB cluster isn't supported for a blue/green deployment.BlueGreenDeploymentAlreadyExistsException
- A blue/green deployment with the specified name already exists.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.DBClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public CreateCustomDBEngineVersionResult createCustomDBEngineVersion(CreateCustomDBEngineVersionRequest request)
Creates a custom DB engine version (CEV).
createCustomDBEngineVersion
in interface AmazonRDS
createCustomDBEngineVersionRequest
- CustomDBEngineVersionAlreadyExistsException
- A CEV with the specified name already exists.CustomDBEngineVersionQuotaExceededException
- You have exceeded your CEV quota.Ec2ImagePropertiesNotSupportedException
- The AMI configuration prerequisite has not been met.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.CreateCustomDBEngineVersionException
- An error occurred while trying to create the CEV.public DBCluster createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier
parameter to create an Amazon Aurora DB cluster as a
read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about
Amazon Aurora, see What is Amazon
Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier
parameter to create a Multi-AZ DB cluster read
replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB
clusters, see Multi-AZ DB
cluster deployments in the Amazon RDS User Guide.
createDBCluster
in interface AmazonRDS
createDBClusterRequest
- DBClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.DBClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBSubnetGroupException
- The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
same source instance.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.OptionGroupNotFoundException
- The specified option group could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBClusterRequest request = new CreateDBClusterRequest().withAvailabilityZones("us-east-1a").withBackupRetentionPeriod(1) .withDatabaseName("myauroradb").withDBClusterIdentifier("mydbcluster").withDBClusterParameterGroupName("mydbclusterparametergroup") .withEngine("aurora").withEngineVersion("5.6.10a").withPort(3306).withMasterUsername("myuser").withMasterUserPassword("mypassword") .withStorageEncrypted(true); DBCluster response = client.createDBCluster(request);
public CreateDBClusterEndpointResult createDBClusterEndpoint(CreateDBClusterEndpointRequest request)
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action applies only to Aurora DB clusters.
createDBClusterEndpoint
in interface AmazonRDS
createDBClusterEndpointRequest
- DBClusterEndpointQuotaExceededException
- The cluster already has the maximum number of custom endpoints.DBClusterEndpointAlreadyExistsException
- The specified custom endpoint can't be created because it already exists.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
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 Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully
complete the create action before the DB cluster parameter group is used as the default for a new DB cluster.
This is especially important for parameters that are critical when creating the default database for a DB
cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
createDBClusterParameterGroup
in interface AmazonRDS
createDBClusterParameterGroupRequest
- DBParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBClusterParameterGroupRequest request = new CreateDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup") .withDBParameterGroupFamily("aurora5.6").withDescription("My DB cluster parameter group"); DBClusterParameterGroup response = client.createDBClusterParameterGroup(request);
public DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
createDBClusterSnapshot
in interface AmazonRDS
createDBClusterSnapshotRequest
- DBClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBClusterSnapshotRequest request = new CreateDBClusterSnapshotRequest().withDBClusterSnapshotIdentifier("mydbclustersnapshot") .withDBClusterIdentifier("mydbcluster"); DBClusterSnapshot response = client.createDBClusterSnapshot(request);
public DBInstance createDBInstance(CreateDBInstanceRequest request)
Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
createDBInstance
in interface AmazonRDS
createDBInstanceRequest
- DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.BackupPolicyNotFoundException
NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.TenantDatabaseQuotaExceededException
- You attempted to create more tenant databases than are permitted in your Amazon Web Services account.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBInstanceRequest request = new CreateDBInstanceRequest().withDBInstanceIdentifier("mymysqlinstance").withAllocatedStorage(5) .withDBInstanceClass("db.t2.micro").withEngine("MySQL").withMasterUsername("MyUser").withMasterUserPassword("MyPassword"); DBInstance response = client.createDBInstance(request);
public DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest request)
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the
CreateDBInstance
operation.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
createDBInstanceReadReplica
in interface AmazonRDS
createDBInstanceReadReplicaRequest
- DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBSubnetGroupNotAllowedException
- The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the
source instance.InvalidDBSubnetGroupException
- The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
same source instance.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.TenantDatabaseQuotaExceededException
- You attempted to create more tenant databases than are permitted in your Amazon Web Services account.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBInstanceReadReplicaRequest request = new CreateDBInstanceReadReplicaRequest().withDBInstanceIdentifier("mydbreadreplica") .withSourceDBInstanceIdentifier("mymysqlinstance").withDBInstanceClass("db.t2.micro").withAvailabilityZone("us-east-1a") .withPubliclyAccessible(true).withTags(new Tag().withKey("mydbreadreplicakey").withValue("mydbreadreplicavalue")).withStorageType("gp2") .withCopyTagsToSnapshot(true); DBInstance response = client.createDBInstanceReadReplica(request);
public DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest request)
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.
This command doesn't apply to RDS Custom.
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
- DBParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBParameterGroupRequest request = new CreateDBParameterGroupRequest().withDBParameterGroupName("mymysqlparametergroup") .withDBParameterGroupFamily("mysql5.6").withDescription("My MySQL parameter group"); DBParameterGroup response = client.createDBParameterGroup(request);
public CreateDBProxyResult createDBProxy(CreateDBProxyRequest request)
Creates a new DB proxy.
createDBProxy
in interface AmazonRDS
createDBProxyRequest
- InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBProxyAlreadyExistsException
- The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyQuotaExceededException
- Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web
Services Region.public CreateDBProxyEndpointResult createDBProxyEndpoint(CreateDBProxyEndpointRequest request)
Creates a DBProxyEndpoint
. Only applies to proxies that are associated with Aurora DB clusters. You
can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy
endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
createDBProxyEndpoint
in interface AmazonRDS
createDBProxyEndpointRequest
- InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyEndpointAlreadyExistsException
- The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DBProxyEndpointQuotaExceededException
- The DB proxy already has the maximum number of endpoints.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest request)
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
createDBSecurityGroup
in interface AmazonRDS
createDBSecurityGroupRequest
- DBSecurityGroupAlreadyExistsException
- A DB security group with the name specified in DBSecurityGroupName
already exists.DBSecurityGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB security groups.DBSecurityGroupNotSupportedException
- A DB security group isn't allowed for this action.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBSecurityGroupRequest request = new CreateDBSecurityGroupRequest().withDBSecurityGroupName("mydbsecuritygroup").withDBSecurityGroupDescription( "My DB security group"); DBSecurityGroup response = client.createDBSecurityGroup(request);
public CreateDBShardGroupResult createDBShardGroup(CreateDBShardGroupRequest request)
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
createDBShardGroup
in interface AmazonRDS
createDBShardGroupRequest
- DBShardGroupAlreadyExistsException
- The specified DB shard group name must be unique in your Amazon Web Services account in the specified
Amazon Web Services Region.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.MaxDBShardGroupLimitReachedException
- The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web
Services Region has been reached.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidMaxAcuException
- The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).UnsupportedDBEngineVersionException
- The specified DB engine version isn't supported for Aurora Limitless Database.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest request)
Creates a snapshot of a DB instance. The source DB instance must be in the available
or
storage-optimization
state.
createDBSnapshot
in interface AmazonRDS
createDBSnapshotRequest
- DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBSnapshotRequest request = new CreateDBSnapshotRequest().withDBSnapshotIdentifier("mydbsnapshot").withDBInstanceIdentifier("mymysqlinstance"); DBSnapshot response = client.createDBSnapshot(request);
public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest request)
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
createDBSubnetGroup
in interface AmazonRDS
createDBSubnetGroupRequest
- DBSubnetGroupAlreadyExistsException
- DBSubnetGroupName
is already used by an existing DB subnet group.DBSubnetGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of DB subnet groups.DBSubnetQuotaExceededException
- The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateDBSubnetGroupRequest request = new CreateDBSubnetGroupRequest().withDBSubnetGroupName("mydbsubnetgroup") .withDBSubnetGroupDescription("My DB subnet group").withSubnetIds("subnet-1fab8a69", "subnet-d43a468c"); DBSubnetGroup response = client.createDBSubnetGroup(request);
public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) 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
) that you want to be notified of and provide a list
of RDS sources (SourceIds
) that triggers the events. You can also provide a list of event categories
(EventCategories
) for events that 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 SourceIds
= myDBInstance1
, you are notified of all the
db-instance
events for the specified source. If you specify a SourceType
but do not
specify SourceIds
, you receive notice of the events for that source type for all your RDS sources.
If you don't specify either the SourceType or the SourceIds
, you are notified of events generated
from all RDS sources belonging to your customer account.
For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.
For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.
createEventSubscription
in interface AmazonRDS
createEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException
- The supplied subscription name already exists.SNSInvalidTopicException
- SNS has responded that there is a problem with the SNS topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SourceNotFoundException
- The requested source could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateEventSubscriptionRequest request = new CreateEventSubscriptionRequest().withSubscriptionName("mymysqleventsubscription") .withSnsTopicArn("arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic").withSourceType("db-instance").withEventCategories("availability") .withSourceIds("mymysqlinstance").withEnabled(true); EventSubscription response = client.createEventSubscription(request);
public GlobalCluster createGlobalCluster(CreateGlobalClusterRequest request)
Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This operation applies only to Aurora DB clusters.
createGlobalCluster
in interface AmazonRDS
createGlobalClusterRequest
- GlobalClusterAlreadyExistsException
- The GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique
name) to create a new global database cluster.GlobalClusterQuotaExceededException
- The number of global database clusters for this account is already at the maximum allowed.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.public CreateIntegrationResult createIntegration(CreateIntegrationRequest request)
Creates a zero-ETL integration with Amazon Redshift.
createIntegration
in interface AmazonRDS
createIntegrationRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.IntegrationAlreadyExistsException
- The integration you are trying to create already exists.IntegrationQuotaExceededException
- You can't crate any more zero-ETL integrations because the quota has been reached.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.IntegrationConflictOperationException
- A conflicting conditional operation is currently in progress against this resource. Typically occurs when
there are multiple requests being made to the same resource at the same time, and these requests conflict
with each other.public OptionGroup createOptionGroup(CreateOptionGroupRequest request)
Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
createOptionGroup
in interface AmazonRDS
createOptionGroupRequest
- OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this Amazon Web Services account.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); CreateOptionGroupRequest request = new CreateOptionGroupRequest().withOptionGroupName("mymysqloptiongroup").withEngineName("MySQL") .withMajorEngineVersion("5.6").withOptionGroupDescription("My MySQL 5.6 option group"); OptionGroup response = client.createOptionGroup(request);
public TenantDatabase createTenantDatabase(CreateTenantDatabaseRequest request)
Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
createTenantDatabase
in interface AmazonRDS
createTenantDatabaseRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.TenantDatabaseAlreadyExistsException
- You attempted to either create a tenant database that already exists or modify a tenant database to use
the name of an existing tenant database.TenantDatabaseQuotaExceededException
- You attempted to create more tenant databases than are permitted in your Amazon Web Services account.public DeleteBlueGreenDeploymentResult deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request)
Deletes a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
deleteBlueGreenDeployment
in interface AmazonRDS
deleteBlueGreenDeploymentRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.InvalidBlueGreenDeploymentStateException
- The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
the green environment.public DeleteCustomDBEngineVersionResult deleteCustomDBEngineVersion(DeleteCustomDBEngineVersionRequest request)
Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway
that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
DeleteCustomDbEngineVersion
event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
deleteCustomDBEngineVersion
in interface AmazonRDS
deleteCustomDBEngineVersionRequest
- CustomDBEngineVersionNotFoundException
- The specified CEV was not found.InvalidCustomDBEngineVersionStateException
- You can't delete the CEV.public DBCluster deleteDBCluster(DeleteDBClusterRequest request)
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
deleteDBCluster
in interface AmazonRDS
deleteDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBClusterSnapshotAlreadyExistsException
- The user already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.DBClusterAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB cluster quota.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBClusterRequest request = new DeleteDBClusterRequest().withDBClusterIdentifier("mydbcluster").withSkipFinalSnapshot(true); DBCluster response = client.deleteDBCluster(request);
public DBClusterAutomatedBackup deleteDBClusterAutomatedBackup(DeleteDBClusterAutomatedBackupRequest request)
Deletes automated backups using the DbClusterResourceId
value of the source DB cluster or the Amazon
Resource Name (ARN) of the automated backups.
deleteDBClusterAutomatedBackup
in interface AmazonRDS
deleteDBClusterAutomatedBackupRequest
- InvalidDBClusterAutomatedBackupStateException
- The automated backup is in an invalid state. For example, this automated backup is associated with an
active cluster.DBClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.public DeleteDBClusterEndpointResult deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest request)
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
deleteDBClusterEndpoint
in interface AmazonRDS
deleteDBClusterEndpointRequest
- InvalidDBClusterEndpointStateException
- The requested operation can't be performed on the endpoint while the endpoint is in this state.DBClusterEndpointNotFoundException
- The specified custom endpoint doesn't exist.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
deleteDBClusterParameterGroup
in interface AmazonRDS
deleteDBClusterParameterGroupRequest
- InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBClusterParameterGroupRequest request = new DeleteDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup"); DeleteDBClusterParameterGroupResult response = client.deleteDBClusterParameterGroup(request);
public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
deleteDBClusterSnapshot
in interface AmazonRDS
deleteDBClusterSnapshotRequest
- InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBClusterSnapshotRequest request = new DeleteDBClusterSnapshotRequest().withDBClusterSnapshotIdentifier("mydbclustersnapshot"); DBClusterSnapshot response = client.deleteDBClusterSnapshot(request);
public DBInstance deleteDBInstance(DeleteDBInstanceRequest request)
Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting
until the
DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of
this operation, use DescribeDBInstance
.
When a DB instance is in a failure state and has a status of failed
,
incompatible-restore
, or incompatible-network
, you can only delete it when you skip
creation of the final snapshot with the SkipFinalSnapshot
parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster
operation to promote
the DB cluster so that it's no longer a read replica. After the promotion completes, use the
DeleteDBInstance
operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
deleteDBInstance
in interface AmazonRDS
deleteDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBInstanceAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB instance quota.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBInstanceRequest request = new DeleteDBInstanceRequest().withDBInstanceIdentifier("mymysqlinstance").withSkipFinalSnapshot(true); DBInstance response = client.deleteDBInstance(request);
public DBInstanceAutomatedBackup deleteDBInstanceAutomatedBackup(DeleteDBInstanceAutomatedBackupRequest request)
Deletes automated backups using the DbiResourceId
value of the source DB instance or the Amazon
Resource Name (ARN) of the automated backups.
deleteDBInstanceAutomatedBackup
in interface AmazonRDS
deleteDBInstanceAutomatedBackupRequest
- Parameter input for the DeleteDBInstanceAutomatedBackup
operation.InvalidDBInstanceAutomatedBackupStateException
- The automated backup is in an invalid state. For example, this automated backup is associated with an
active instance.DBInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.public DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
deleteDBParameterGroup
in interface AmazonRDS
deleteDBParameterGroupRequest
- InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBParameterGroupRequest request = new DeleteDBParameterGroupRequest().withDBParameterGroupName("mydbparamgroup3"); DeleteDBParameterGroupResult response = client.deleteDBParameterGroup(request);
public DeleteDBProxyResult deleteDBProxy(DeleteDBProxyRequest request)
Deletes an existing DB proxy.
deleteDBProxy
in interface AmazonRDS
deleteDBProxyRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public DeleteDBProxyEndpointResult deleteDBProxyEndpoint(DeleteDBProxyEndpointRequest request)
Deletes a DBProxyEndpoint
. Doing so removes the ability to access the DB proxy using the endpoint
that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only
operations, or using a different VPC than the DB proxy's default VPC.
deleteDBProxyEndpoint
in interface AmazonRDS
deleteDBProxyEndpointRequest
- DBProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.InvalidDBProxyEndpointStateException
- You can't perform this operation while the DB proxy endpoint is in a particular state.public DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
deleteDBSecurityGroup
in interface AmazonRDS
deleteDBSecurityGroupRequest
- InvalidDBSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBSecurityGroupRequest request = new DeleteDBSecurityGroupRequest().withDBSecurityGroupName("mysecgroup"); DeleteDBSecurityGroupResult response = client.deleteDBSecurityGroup(request);
public DeleteDBShardGroupResult deleteDBShardGroup(DeleteDBShardGroupRequest request)
Deletes an Aurora Limitless Database DB shard group.
deleteDBShardGroup
in interface AmazonRDS
deleteDBShardGroupRequest
- DBShardGroupNotFoundException
- The specified DB shard group name wasn't found.InvalidDBShardGroupStateException
- The DB shard group must be in the available state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest request)
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available
state to be deleted.
deleteDBSnapshot
in interface AmazonRDS
deleteDBSnapshotRequest
- InvalidDBSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBSnapshotRequest request = new DeleteDBSnapshotRequest().withDBSnapshotIdentifier("mydbsnapshot"); DBSnapshot response = client.deleteDBSnapshot(request);
public DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroup
in interface AmazonRDS
deleteDBSubnetGroupRequest
- InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidDBSubnetStateException
- The DB subnet isn't in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteDBSubnetGroupRequest request = new DeleteDBSubnetGroupRequest().withDBSubnetGroupName("mydbsubnetgroup"); DeleteDBSubnetGroupResult response = client.deleteDBSubnetGroup(request);
public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an RDS event notification subscription.
deleteEventSubscription
in interface AmazonRDS
deleteEventSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.InvalidEventSubscriptionStateException
- This error can occur if someone else is modifying a subscription. You should retry the action.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteEventSubscriptionRequest request = new DeleteEventSubscriptionRequest().withSubscriptionName("myeventsubscription"); EventSubscription response = client.deleteEventSubscription(request);
public GlobalCluster deleteGlobalCluster(DeleteGlobalClusterRequest request)
Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
deleteGlobalCluster
in interface AmazonRDS
deleteGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
Deletes a zero-ETL integration with Amazon Redshift.
deleteIntegration
in interface AmazonRDS
deleteIntegrationRequest
- IntegrationNotFoundException
- The specified integration could not be found.IntegrationConflictOperationException
- A conflicting conditional operation is currently in progress against this resource. Typically occurs when
there are multiple requests being made to the same resource at the same time, and these requests conflict
with each other.InvalidIntegrationStateException
- The integration is in an invalid state and can't perform the requested operation.public DeleteOptionGroupResult deleteOptionGroup(DeleteOptionGroupRequest request)
Deletes an existing option group.
deleteOptionGroup
in interface AmazonRDS
deleteOptionGroupRequest
- OptionGroupNotFoundException
- The specified option group could not be found.InvalidOptionGroupStateException
- The option group isn't in the available state.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DeleteOptionGroupRequest request = new DeleteOptionGroupRequest().withOptionGroupName("mydboptiongroup"); DeleteOptionGroupResult response = client.deleteOptionGroup(request);
public TenantDatabase deleteTenantDatabase(DeleteTenantDatabaseRequest request)
Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can't delete a tenant database when it is the only tenant in the DB instance.
deleteTenantDatabase
in interface AmazonRDS
deleteTenantDatabaseRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.TenantDatabaseNotFoundException
- The specified tenant database wasn't found in the DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DeregisterDBProxyTargetsResult deregisterDBProxyTargets(DeregisterDBProxyTargetsRequest request)
Remove the association between one or more DBProxyTarget
data structures and a
DBProxyTargetGroup
.
deregisterDBProxyTargets
in interface AmazonRDS
deregisterDBProxyTargetsRequest
- DBProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
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 doesn't take any parameters.
describeAccountAttributes
in interface AmazonRDS
describeAccountAttributesRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest(); DescribeAccountAttributesResult response = client.describeAccountAttributes(request);
public DescribeAccountAttributesResult describeAccountAttributes()
AmazonRDS
describeAccountAttributes
in interface AmazonRDS
AmazonRDS.describeAccountAttributes(DescribeAccountAttributesRequest)
public DescribeBlueGreenDeploymentsResult describeBlueGreenDeployments(DescribeBlueGreenDeploymentsRequest request)
Describes one or more blue/green deployments.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
describeBlueGreenDeployments
in interface AmazonRDS
describeBlueGreenDeploymentsRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
describeCertificates
in interface AmazonRDS
describeCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeCertificatesRequest request = new DescribeCertificatesRequest().withCertificateIdentifier("rds-ca-2015").withMaxRecords(20); DescribeCertificatesResult response = client.describeCertificates(request);
public DescribeCertificatesResult describeCertificates()
AmazonRDS
describeCertificates
in interface AmazonRDS
AmazonRDS.describeCertificates(DescribeCertificatesRequest)
public DescribeDBClusterAutomatedBackupsResult describeDBClusterAutomatedBackups(DescribeDBClusterAutomatedBackupsRequest request)
Displays backups for both current and deleted DB clusters. For example, use this operation to find details about
automated backups for previously deleted clusters. Current clusters are returned for both the
DescribeDBClusterAutomatedBackups
and DescribeDBClusters
operations.
All parameters are optional.
describeDBClusterAutomatedBackups
in interface AmazonRDS
describeDBClusterAutomatedBackupsRequest
- DBClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.public DescribeDBClusterBacktracksResult describeDBClusterBacktracks(DescribeDBClusterBacktracksRequest request)
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
describeDBClusterBacktracks
in interface AmazonRDS
describeDBClusterBacktracksRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBClusterBacktrackNotFoundException
- BacktrackIdentifier
doesn't refer to an existing backtrack.public DescribeDBClusterEndpointsResult describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest request)
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
describeDBClusterEndpoints
in interface AmazonRDS
describeDBClusterEndpointsRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
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 What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
describeDBClusterParameterGroups
in interface AmazonRDS
describeDBClusterParameterGroupsRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBClusterParameterGroupsRequest request = new DescribeDBClusterParameterGroupsRequest() .withDBClusterParameterGroupName("mydbclusterparametergroup"); DescribeDBClusterParameterGroupsResult response = client.describeDBClusterParameterGroups(request);
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups()
AmazonRDS
describeDBClusterParameterGroups
in interface AmazonRDS
AmazonRDS.describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest)
public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest request)
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
describeDBClusterParameters
in interface AmazonRDS
describeDBClusterParametersRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBClusterParametersRequest request = new DescribeDBClusterParametersRequest().withDBClusterParameterGroupName("mydbclusterparametergroup") .withSource("system"); DescribeDBClusterParametersResult response = client.describeDBClusterParameters(request);
public DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
returns the restore
attribute and a list of IDs for the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If all
is included in the list of
values for the restore
attribute, then the manual DB cluster snapshot is public and can be copied or
restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to
make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute
API
action.
describeDBClusterSnapshotAttributes
in interface AmazonRDS
describeDBClusterSnapshotAttributesRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBClusterSnapshotAttributesRequest request = new DescribeDBClusterSnapshotAttributesRequest() .withDBClusterSnapshotIdentifier("mydbclustersnapshot"); DBClusterSnapshotAttributesResult response = client.describeDBClusterSnapshotAttributes(request);
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
describeDBClusterSnapshots
in interface AmazonRDS
describeDBClusterSnapshotsRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBClusterSnapshotsRequest request = new DescribeDBClusterSnapshotsRequest().withDBClusterSnapshotIdentifier("mydbclustersnapshot") .withSnapshotType("manual"); DescribeDBClusterSnapshotsResult response = client.describeDBClusterSnapshots(request);
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots()
AmazonRDS
describeDBClusterSnapshots
in interface AmazonRDS
AmazonRDS.describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)
public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest request)
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBClusters
in interface AmazonRDS
describeDBClustersRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBClustersRequest request = new DescribeDBClustersRequest().withDBClusterIdentifier("mynewdbcluster"); DescribeDBClustersResult response = client.describeDBClusters(request);
public DescribeDBClustersResult describeDBClusters()
AmazonRDS
describeDBClusters
in interface AmazonRDS
AmazonRDS.describeDBClusters(DescribeDBClustersRequest)
public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
Describes the properties of specific versions of DB engines.
describeDBEngineVersions
in interface AmazonRDS
describeDBEngineVersionsRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBEngineVersionsRequest request = new DescribeDBEngineVersionsRequest().withEngine("mysql").withEngineVersion("5.6") .withDBParameterGroupFamily("mysql5.6").withDefaultOnly(true).withListSupportedCharacterSets(true); DescribeDBEngineVersionsResult response = client.describeDBEngineVersions(request);
public DescribeDBEngineVersionsResult describeDBEngineVersions()
AmazonRDS
describeDBEngineVersions
in interface AmazonRDS
AmazonRDS.describeDBEngineVersions(DescribeDBEngineVersionsRequest)
public DescribeDBInstanceAutomatedBackupsResult describeDBInstanceAutomatedBackups(DescribeDBInstanceAutomatedBackupsRequest request)
Displays backups for both current and deleted instances. For example, use this operation to find details about
automated backups for previously deleted instances. Current instances with retention periods greater than zero
(0) are returned for both the DescribeDBInstanceAutomatedBackups
and
DescribeDBInstances
operations.
All parameters are optional.
describeDBInstanceAutomatedBackups
in interface AmazonRDS
describeDBInstanceAutomatedBackupsRequest
- Parameter input for DescribeDBInstanceAutomatedBackups.DBInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)
Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBInstances
in interface AmazonRDS
describeDBInstancesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBInstancesRequest request = new DescribeDBInstancesRequest().withDBInstanceIdentifier("mymysqlinstance"); DescribeDBInstancesResult response = client.describeDBInstances(request);
public DescribeDBInstancesResult describeDBInstances()
AmazonRDS
describeDBInstances
in interface AmazonRDS
AmazonRDS.describeDBInstances(DescribeDBInstancesRequest)
public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest request)
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
describeDBLogFiles
in interface AmazonRDS
describeDBLogFilesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBLogFilesRequest request = new DescribeDBLogFilesRequest().withDBInstanceIdentifier("mymysqlinstance").withFilenameContains("error") .withFileLastWritten(1470873600000L).withFileSize(0L); DescribeDBLogFilesResult response = client.describeDBLogFiles(request);
public DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
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
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBParameterGroupsRequest request = new DescribeDBParameterGroupsRequest().withDBParameterGroupName("mymysqlparametergroup"); DescribeDBParameterGroupsResult response = client.describeDBParameterGroups(request);
public DescribeDBParameterGroupsResult describeDBParameterGroups()
AmazonRDS
describeDBParameterGroups
in interface AmazonRDS
AmazonRDS.describeDBParameterGroups(DescribeDBParameterGroupsRequest)
public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest request)
Returns the detailed parameter list for a particular DB parameter group.
describeDBParameters
in interface AmazonRDS
describeDBParametersRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBParametersRequest request = new DescribeDBParametersRequest().withDBParameterGroupName("mymysqlparametergroup").withSource("system") .withMaxRecords(20); DescribeDBParametersResult response = client.describeDBParameters(request);
public DescribeDBProxiesResult describeDBProxies(DescribeDBProxiesRequest request)
Returns information about DB proxies.
describeDBProxies
in interface AmazonRDS
describeDBProxiesRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.public DescribeDBProxyEndpointsResult describeDBProxyEndpoints(DescribeDBProxyEndpointsRequest request)
Returns information about DB proxy endpoints.
describeDBProxyEndpoints
in interface AmazonRDS
describeDBProxyEndpointsRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.public DescribeDBProxyTargetGroupsResult describeDBProxyTargetGroups(DescribeDBProxyTargetGroupsRequest request)
Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
describeDBProxyTargetGroups
in interface AmazonRDS
describeDBProxyTargetGroupsRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public DescribeDBProxyTargetsResult describeDBProxyTargets(DescribeDBProxyTargetsRequest request)
Returns information about DBProxyTarget
objects. This API supports pagination.
describeDBProxyTargets
in interface AmazonRDS
describeDBProxyTargetsRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetNotFoundException
- The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web
Services account in the specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public DescribeDBRecommendationsResult describeDBRecommendations(DescribeDBRecommendationsRequest request)
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
describeDBRecommendations
in interface AmazonRDS
describeDBRecommendationsRequest
- public DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest request)
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
the list will contain only the descriptions of the specified DB security group.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
describeDBSecurityGroups
in interface AmazonRDS
describeDBSecurityGroupsRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBSecurityGroupsRequest request = new DescribeDBSecurityGroupsRequest().withDBSecurityGroupName("mydbsecuritygroup"); DescribeDBSecurityGroupsResult response = client.describeDBSecurityGroups(request);
public DescribeDBSecurityGroupsResult describeDBSecurityGroups()
AmazonRDS
describeDBSecurityGroups
in interface AmazonRDS
AmazonRDS.describeDBSecurityGroups(DescribeDBSecurityGroupsRequest)
public DescribeDBShardGroupsResult describeDBShardGroups(DescribeDBShardGroupsRequest request)
Describes existing Aurora Limitless Database DB shard groups.
describeDBShardGroups
in interface AmazonRDS
describeDBShardGroupsRequest
- DBShardGroupNotFoundException
- The specified DB shard group name wasn't found.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.public DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest request)
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes
returns
the restore
attribute and a list of IDs for the Amazon Web Services accounts 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 Amazon
Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make
the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute
API action.
describeDBSnapshotAttributes
in interface AmazonRDS
describeDBSnapshotAttributesRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBSnapshotAttributesRequest request = new DescribeDBSnapshotAttributesRequest().withDBSnapshotIdentifier("mydbsnapshot"); DBSnapshotAttributesResult response = client.describeDBSnapshotAttributes(request);
public DBSnapshotAttributesResult describeDBSnapshotAttributes()
AmazonRDS
describeDBSnapshotAttributes
in interface AmazonRDS
AmazonRDS.describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)
public DescribeDBSnapshotTenantDatabasesResult describeDBSnapshotTenantDatabases(DescribeDBSnapshotTenantDatabasesRequest request)
Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.
You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.
describeDBSnapshotTenantDatabases
in interface AmazonRDS
describeDBSnapshotTenantDatabasesRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest request)
Returns information about DB snapshots. This API action supports pagination.
describeDBSnapshots
in interface AmazonRDS
describeDBSnapshotsRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBSnapshotsRequest request = new DescribeDBSnapshotsRequest().withDBInstanceIdentifier("mymysqlinstance").withSnapshotType("manual") .withIncludeShared(true).withIncludePublic(false); DescribeDBSnapshotsResult response = client.describeDBSnapshots(request);
public DescribeDBSnapshotsResult describeDBSnapshots()
AmazonRDS
describeDBSnapshots
in interface AmazonRDS
AmazonRDS.describeDBSnapshots(DescribeDBSnapshotsRequest)
public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
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
- DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeDBSubnetGroupsRequest request = new DescribeDBSubnetGroupsRequest().withDBSubnetGroupName("mydbsubnetgroup"); DescribeDBSubnetGroupsResult response = client.describeDBSubnetGroups(request);
public DescribeDBSubnetGroupsResult describeDBSubnetGroups()
AmazonRDS
describeDBSubnetGroups
in interface AmazonRDS
AmazonRDS.describeDBSubnetGroups(DescribeDBSubnetGroupsRequest)
public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
describeEngineDefaultClusterParameters
in interface AmazonRDS
describeEngineDefaultClusterParametersRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeEngineDefaultClusterParametersRequest request = new DescribeEngineDefaultClusterParametersRequest().withDBParameterGroupFamily("aurora5.6"); EngineDefaults response = client.describeEngineDefaultClusterParameters(request);
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParameters
in interface AmazonRDS
describeEngineDefaultParametersRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeEngineDefaultParametersRequest request = new DescribeEngineDefaultParametersRequest().withDBParameterGroupFamily("mysql5.6"); EngineDefaults response = client.describeEngineDefaultParameters(request);
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
describeEventCategories
in interface AmazonRDS
describeEventCategoriesRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeEventCategoriesRequest request = new DescribeEventCategoriesRequest().withSourceType("db-instance"); DescribeEventCategoriesResult response = client.describeEventCategories(request);
public DescribeEventCategoriesResult describeEventCategories()
AmazonRDS
describeEventCategories
in interface AmazonRDS
AmazonRDS.describeEventCategories(DescribeEventCategoriesRequest)
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
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
- SubscriptionNotFoundException
- The subscription name does not exist.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeEventSubscriptionsRequest request = new DescribeEventSubscriptionsRequest().withSubscriptionName("mymysqleventsubscription"); DescribeEventSubscriptionsResult response = client.describeEventSubscriptions(request);
public DescribeEventSubscriptionsResult describeEventSubscriptions()
AmazonRDS
describeEventSubscriptions
in interface AmazonRDS
AmazonRDS.describeEventSubscriptions(DescribeEventSubscriptionsRequest)
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
describeEvents
in interface AmazonRDS
describeEventsRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeEventsRequest request = new DescribeEventsRequest().withSourceIdentifier("mymysqlinstance").withSourceType("db-instance").withDuration(10080) .withEventCategories("backup"); DescribeEventsResult response = client.describeEvents(request);
public DescribeEventsResult describeEvents()
AmazonRDS
describeEvents
in interface AmazonRDS
AmazonRDS.describeEvents(DescribeEventsRequest)
public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.
describeExportTasks
in interface AmazonRDS
describeExportTasksRequest
- ExportTaskNotFoundException
- The export task doesn't exist.public DescribeGlobalClustersResult describeGlobalClusters(DescribeGlobalClustersRequest request)
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
describeGlobalClusters
in interface AmazonRDS
describeGlobalClustersRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.public DescribeIntegrationsResult describeIntegrations(DescribeIntegrationsRequest request)
Describe one or more zero-ETL integrations with Amazon Redshift.
describeIntegrations
in interface AmazonRDS
describeIntegrationsRequest
- IntegrationNotFoundException
- The specified integration could not be found.public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
Describes all available options for the specified engine.
describeOptionGroupOptions
in interface AmazonRDS
describeOptionGroupOptionsRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeOptionGroupOptionsRequest request = new DescribeOptionGroupOptionsRequest().withEngineName("mysql").withMajorEngineVersion("5.6"); DescribeOptionGroupOptionsResult response = client.describeOptionGroupOptions(request);
public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest request)
Describes the available option groups.
describeOptionGroups
in interface AmazonRDS
describeOptionGroupsRequest
- OptionGroupNotFoundException
- The specified option group could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeOptionGroupsRequest request = new DescribeOptionGroupsRequest().withEngineName("mysql").withMajorEngineVersion("5.6"); DescribeOptionGroupsResult response = client.describeOptionGroups(request);
public DescribeOptionGroupsResult describeOptionGroups()
AmazonRDS
describeOptionGroups
in interface AmazonRDS
AmazonRDS.describeOptionGroups(DescribeOptionGroupsRequest)
public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
Describes the orderable DB instance options for a specified DB engine.
describeOrderableDBInstanceOptions
in interface AmazonRDS
describeOrderableDBInstanceOptionsRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeOrderableDBInstanceOptionsRequest request = new DescribeOrderableDBInstanceOptionsRequest().withEngine("mysql").withEngineVersion("5.6.27") .withDBInstanceClass("db.t2.micro").withLicenseModel("general-public-license").withVpc(true); DescribeOrderableDBInstanceOptionsResult response = client.describeOrderableDBInstanceOptions(request);
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This API follows an eventual consistency model. This means that the result of the
DescribePendingMaintenanceActions
command might not be immediately visible to all subsequent RDS
commands. Keep this in mind when you use DescribePendingMaintenanceActions
immediately after using a
previous API command such as ApplyPendingMaintenanceActions
.
describePendingMaintenanceActions
in interface AmazonRDS
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The specified resource ID was not found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribePendingMaintenanceActionsRequest request = new DescribePendingMaintenanceActionsRequest() .withResourceIdentifier("arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"); DescribePendingMaintenanceActionsResult response = client.describePendingMaintenanceActions(request);
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions()
AmazonRDS
describePendingMaintenanceActions
in interface AmazonRDS
AmazonRDS.describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest request)
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstances
in interface AmazonRDS
describeReservedDBInstancesRequest
- ReservedDBInstanceNotFoundException
- The specified reserved DB Instance not found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeReservedDBInstancesRequest request = new DescribeReservedDBInstancesRequest().withDBInstanceClass("db.t2.micro").withDuration("1y") .withProductDescription("mysql").withOfferingType("No Upfront").withMultiAZ(false); DescribeReservedDBInstancesResult response = client.describeReservedDBInstances(request);
public DescribeReservedDBInstancesResult describeReservedDBInstances()
AmazonRDS
describeReservedDBInstances
in interface AmazonRDS
AmazonRDS.describeReservedDBInstances(DescribeReservedDBInstancesRequest)
public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest request)
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferings
in interface AmazonRDS
describeReservedDBInstancesOfferingsRequest
- ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeReservedDBInstancesOfferingsRequest request = new DescribeReservedDBInstancesOfferingsRequest().withDBInstanceClass("db.t2.micro") .withDuration("1y").withProductDescription("mysql").withOfferingType("No Upfront").withMultiAZ(false); DescribeReservedDBInstancesOfferingsResult response = client.describeReservedDBInstancesOfferings(request);
public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
AmazonRDS
describeReservedDBInstancesOfferings
in interface AmazonRDS
AmazonRDS.describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest)
public DescribeSourceRegionsResult describeSourceRegions(DescribeSourceRegionsRequest request)
Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation
DescribeRegions
. For more information, see DescribeRegions in
the Amazon EC2 API Reference.
describeSourceRegions
in interface AmazonRDS
describeSourceRegionsRequest
- AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DescribeSourceRegionsRequest request = new DescribeSourceRegionsRequest(); DescribeSourceRegionsResult response = client.describeSourceRegions(request);
public DescribeTenantDatabasesResult describeTenantDatabases(DescribeTenantDatabasesRequest request)
Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.
describeTenantDatabases
in interface AmazonRDS
describeTenantDatabasesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.public ValidDBInstanceModificationsMessage describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
You can call DescribeValidDBInstanceModifications
to learn what modifications you can make to your
DB instance. You can use this information when you call ModifyDBInstance
.
This command doesn't apply to RDS Custom.
describeValidDBInstanceModifications
in interface AmazonRDS
describeValidDBInstanceModificationsRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DisableHttpEndpointResult disableHttpEndpoint(DisableHttpEndpointRequest request)
Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP
endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint
parameter of the
ModifyDBCluster
operation.
disableHttpEndpoint
in interface AmazonRDS
disableHttpEndpointRequest
- ResourceNotFoundException
- The specified resource ID was not found.InvalidResourceStateException
- The operation can't be performed because another operation is in progress.public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
downloadDBLogFilePortion
in interface AmazonRDS
downloadDBLogFilePortionRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBLogFileNotFoundException
- LogFileName
doesn't refer to an existing DB log file.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); DownloadDBLogFilePortionRequest request = new DownloadDBLogFilePortionRequest().withDBInstanceIdentifier("mymysqlinstance").withLogFileName( "mysqlUpgrade"); DownloadDBLogFilePortionResult response = client.downloadDBLogFilePortion(request);
public EnableHttpEndpointResult enableHttpEndpoint(EnableHttpEndpointRequest request)
Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP
endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint
parameter of the
ModifyDBCluster
operation.
enableHttpEndpoint
in interface AmazonRDS
enableHttpEndpointRequest
- ResourceNotFoundException
- The specified resource ID was not found.InvalidResourceStateException
- The operation can't be performed because another operation is in progress.public DBCluster failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
failoverDBCluster
in interface AmazonRDS
failoverDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); FailoverDBClusterRequest request = new FailoverDBClusterRequest().withDBClusterIdentifier("myaurorainstance-cluster").withTargetDBInstanceIdentifier( "myaurorareplica"); DBCluster response = client.failoverDBCluster(request);
public DBCluster failoverDBCluster()
AmazonRDS
failoverDBCluster
in interface AmazonRDS
AmazonRDS.failoverDBCluster(FailoverDBClusterRequest)
public GlobalCluster failoverGlobalCluster(FailoverGlobalClusterRequest request)
Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."
Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.
How you use this operation depends on whether you are failing over or switching over your global database cluster:
Failing over - Specify the AllowDataLoss
parameter and don't specify the Switchover
parameter.
Switching over - Specify the Switchover
parameter or omit it, but don't specify the
AllowDataLoss
parameter.
About failing over and switching over
While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:
Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.
Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.
For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
failoverGlobalCluster
in interface AmazonRDS
failoverGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
listTagsForResource
in interface AmazonRDS
listTagsForResourceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.IntegrationNotFoundException
- The specified integration could not be found.TenantDatabaseNotFoundException
- The specified tenant database wasn't found in the DB instance.DBSnapshotTenantDatabaseNotFoundException
- The specified snapshot tenant database wasn't found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ListTagsForResourceRequest request = new ListTagsForResourceRequest().withResourceName("arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"); ListTagsForResourceResult response = client.listTagsForResource(request);
public ModifyActivityStreamResult modifyActivityStream(ModifyActivityStreamRequest request)
Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.
This operation is supported for RDS for Oracle and Microsoft SQL Server.
modifyActivityStream
in interface AmazonRDS
modifyActivityStreamRequest
- InvalidDBInstanceStateException
- The DB instance isn't in a valid state.ResourceNotFoundException
- The specified resource ID was not found.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.public Certificate modifyCertificates(ModifyCertificatesRequest request)
Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
modifyCertificates
in interface AmazonRDS
modifyCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.public ModifyCurrentDBClusterCapacityResult modifyCurrentDBClusterCapacity(ModifyCurrentDBClusterCapacityRequest request)
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might
not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call
ModifyCurrentDBClusterCapacity
to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity
with the default TimeoutAction
, connections
that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about
scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
modifyCurrentDBClusterCapacity
in interface AmazonRDS
modifyCurrentDBClusterCapacityRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBClusterCapacityException
- Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
2
, 4
, 8
, 16
, 32
, 64
,
128
, and 256
.public ModifyCustomDBEngineVersionResult modifyCustomDBEngineVersion(ModifyCustomDBEngineVersionRequest request)
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling
DescribeDBEngineVersions
.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
ModifyCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway
that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
ModifyCustomDbEngineVersion
event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
modifyCustomDBEngineVersion
in interface AmazonRDS
modifyCustomDBEngineVersionRequest
- CustomDBEngineVersionNotFoundException
- The specified CEV was not found.InvalidCustomDBEngineVersionStateException
- You can't delete the CEV.public DBCluster modifyDBCluster(ModifyDBClusterRequest request)
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
modifyDBCluster
in interface AmazonRDS
modifyDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InvalidDBSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.StorageTypeNotAvailableException
- The aurora-iopt1
storage type isn't available, because you modified the DB cluster to use
this storage type less than one month ago.OptionGroupNotFoundException
- The specified option group could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBClusterRequest request = new ModifyDBClusterRequest().withDBClusterIdentifier("mydbcluster").withNewDBClusterIdentifier("mynewdbcluster") .withApplyImmediately(true).withMasterUserPassword("mynewpassword").withPreferredBackupWindow("04:00-04:30") .withPreferredMaintenanceWindow("Tue:05:00-Tue:05:30"); DBCluster response = client.modifyDBCluster(request);
public ModifyDBClusterEndpointResult modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest request)
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This operation only applies to Aurora DB clusters.
modifyDBClusterEndpoint
in interface AmazonRDS
modifyDBClusterEndpointRequest
- InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBClusterEndpointStateException
- The requested operation can't be performed on the endpoint while the endpoint is in this state.DBClusterEndpointNotFoundException
- The specified custom endpoint doesn't exist.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
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.
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 operation 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
operation to verify that your DB cluster parameter
group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
modifyDBClusterParameterGroup
in interface AmazonRDS
modifyDBClusterParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBClusterParameterGroupRequest request = new ModifyDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup") .withParameters(new Parameter().withParameterName("time_zone").withParameterValue("America/Phoenix").withApplyMethod("immediate")); ModifyDBClusterParameterGroupResult response = client.modifyDBClusterParameterGroup(request);
public DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore
as
the AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon
Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value
all
to make the manual DB cluster snapshot public, which means that it can be copied or restored by
all Amazon Web Services accounts.
Don't add the all
value for any manual DB cluster snapshots that contain private information that
you don't want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized
Amazon Web Services account IDs for the ValuesToAdd
parameter. You can't use all
as a
value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or
whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API
operation. The accounts are returned as values for the restore
attribute.
modifyDBClusterSnapshotAttribute
in interface AmazonRDS
modifyDBClusterSnapshotAttributeRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBClusterSnapshotAttributeRequest request = new ModifyDBClusterSnapshotAttributeRequest() .withDBClusterSnapshotIdentifier("manual-cluster-snapshot1").withAttributeName("restore").withValuesToAdd("123451234512", "123456789012") .withValuesToRemove("all"); DBClusterSnapshotAttributesResult response = client.modifyDBClusterSnapshotAttribute(request);
public DBInstance modifyDBInstance(ModifyDBInstanceRequest request)
Modifies 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. To learn what modifications you can make to your DB instance,
call DescribeValidDBInstanceModifications
before you call ModifyDBInstance
.
modifyDBInstance
in interface AmazonRDS
modifyDBInstanceRequest
- InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InvalidDBSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBUpgradeDependencyFailureException
- The DB upgrade failed because a resource the DB depends on can't be modified.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.BackupPolicyNotFoundException
KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.TenantDatabaseQuotaExceededException
- You attempted to create more tenant databases than are permitted in your Amazon Web Services account.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBInstanceRequest request = new ModifyDBInstanceRequest().withDBInstanceIdentifier("mymysqlinstance").withAllocatedStorage(10) .withDBInstanceClass("db.t2.small").withApplyImmediately(true).withMasterUserPassword("mynewpassword").withBackupRetentionPeriod(1) .withPreferredBackupWindow("04:00-04:30").withPreferredMaintenanceWindow("Tue:05:00-Tue:05:30"); DBInstance response = client.modifyDBInstance(request);
public ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
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.
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 operation 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
- DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBParameterGroupRequest request = new ModifyDBParameterGroupRequest().withDBParameterGroupName("mymysqlparametergroup").withParameters( new Parameter().withParameterName("time_zone").withParameterValue("America/Phoenix").withApplyMethod("immediate")); ModifyDBParameterGroupResult response = client.modifyDBParameterGroup(request);
public ModifyDBProxyResult modifyDBProxy(ModifyDBProxyRequest request)
Changes the settings for an existing DB proxy.
modifyDBProxy
in interface AmazonRDS
modifyDBProxyRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyAlreadyExistsException
- The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public ModifyDBProxyEndpointResult modifyDBProxyEndpoint(ModifyDBProxyEndpointRequest request)
Changes the settings for an existing DB proxy endpoint.
modifyDBProxyEndpoint
in interface AmazonRDS
modifyDBProxyEndpointRequest
- DBProxyEndpointNotFoundException
- The DB proxy endpoint doesn't exist.DBProxyEndpointAlreadyExistsException
- The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web
Services account in the specified Amazon Web Services Region.InvalidDBProxyEndpointStateException
- You can't perform this operation while the DB proxy endpoint is in a particular state.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public ModifyDBProxyTargetGroupResult modifyDBProxyTargetGroup(ModifyDBProxyTargetGroupRequest request)
Modifies the properties of a DBProxyTargetGroup
.
modifyDBProxyTargetGroup
in interface AmazonRDS
modifyDBProxyTargetGroupRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.public ModifyDBRecommendationResult modifyDBRecommendation(ModifyDBRecommendationRequest request)
Updates the recommendation status and recommended action status for the specified recommendation.
modifyDBRecommendation
in interface AmazonRDS
modifyDBRecommendationRequest
- public ModifyDBShardGroupResult modifyDBShardGroup(ModifyDBShardGroupRequest request)
Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
modifyDBShardGroup
in interface AmazonRDS
modifyDBShardGroupRequest
- InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBShardGroupAlreadyExistsException
- The specified DB shard group name must be unique in your Amazon Web Services account in the specified
Amazon Web Services Region.DBShardGroupNotFoundException
- The specified DB shard group name wasn't found.InvalidMaxAcuException
- The maximum capacity of the DB shard group must be 48-7168 Aurora capacity units (ACUs).public DBSnapshot modifyDBSnapshot(ModifyDBSnapshotRequest request)
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
modifyDBSnapshot
in interface AmazonRDS
modifyDBSnapshotRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.public DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest request)
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 Amazon Web Services accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual DB snapshot. Uses the value all
to make
the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Don't add the all
value for any manual DB snapshots that contain private information that you don't
want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web
Services account IDs for the ValuesToAdd
parameter. You can't use all
as a value for
that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a
manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are
returned as values for the restore
attribute.
modifyDBSnapshotAttribute
in interface AmazonRDS
modifyDBSnapshotAttributeRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBSnapshotAttributeRequest request = new ModifyDBSnapshotAttributeRequest().withDBSnapshotIdentifier("mydbsnapshot").withAttributeName("restore") .withValuesToAdd("all"); DBSnapshotAttributesResult response = client.modifyDBSnapshotAttribute(request);
public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
modifyDBSubnetGroup
in interface AmazonRDS
modifyDBSubnetGroupRequest
- DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetQuotaExceededException
- The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException
- The DB subnet is already in use in the Availability Zone.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyDBSubnetGroupRequest request = new ModifyDBSubnetGroupRequest().withDBSubnetGroupName("mydbsubnetgroup").withSubnetIds("subnet-70e1975a", "subnet-747a5c49"); DBSubnetGroup response = client.modifyDBSubnetGroup(request);
public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing RDS event notification subscription. You can't 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 source type (SourceType
) in Events in the Amazon RDS
User Guide or by using the DescribeEventCategories
operation.
modifyEventSubscription
in interface AmazonRDS
modifyEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException
- The subscription name does not exist.SNSInvalidTopicException
- SNS has responded that there is a problem with the SNS topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyEventSubscriptionRequest request = new ModifyEventSubscriptionRequest().withSubscriptionName("mymysqleventsubscription") .withSourceType("db-instance").withEventCategories("deletion", "low storage").withEnabled(true); EventSubscription response = client.modifyEventSubscription(request);
public GlobalCluster modifyGlobalCluster(ModifyGlobalClusterRequest request)
Modifies a setting for an Amazon Aurora global database 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 What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora global database clusters.
modifyGlobalCluster
in interface AmazonRDS
modifyGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public ModifyIntegrationResult modifyIntegration(ModifyIntegrationRequest request)
Modifies a zero-ETL integration with Amazon Redshift.
Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.
modifyIntegration
in interface AmazonRDS
modifyIntegrationRequest
- IntegrationNotFoundException
- The specified integration could not be found.InvalidIntegrationStateException
- The integration is in an invalid state and can't perform the requested operation.IntegrationConflictOperationException
- A conflicting conditional operation is currently in progress against this resource. Typically occurs when
there are multiple requests being made to the same resource at the same time, and these requests conflict
with each other.public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest request)
Modifies an existing option group.
modifyOptionGroup
in interface AmazonRDS
modifyOptionGroupRequest
- InvalidOptionGroupStateException
- The option group isn't in the available state.OptionGroupNotFoundException
- The specified option group could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ModifyOptionGroupRequest request = new ModifyOptionGroupRequest().withOptionGroupName("myawsuser-og02") .withOptionsToInclude(new OptionConfiguration().withOptionName("MEMCACHED").withDBSecurityGroupMemberships("default")) .withApplyImmediately(true); OptionGroup response = client.modifyOptionGroup(request);
public TenantDatabase modifyTenantDatabase(ModifyTenantDatabaseRequest request)
Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.
modifyTenantDatabase
in interface AmazonRDS
modifyTenantDatabaseRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.TenantDatabaseNotFoundException
- The specified tenant database wasn't found in the DB instance.TenantDatabaseAlreadyExistsException
- You attempted to either create a tenant database that already exists or modify a tenant database to use
the name of an existing tenant database.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DBInstance promoteReadReplica(PromoteReadReplicaRequest request)
Promotes a read replica DB instance to a standalone DB instance.
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to
promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one
backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in
the backing-up
status. If you have enabled backups on your read replica, configure the automated
backup window so that daily backups do not interfere with read replica promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
promoteReadReplica
in interface AmazonRDS
promoteReadReplicaRequest
- InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); PromoteReadReplicaRequest request = new PromoteReadReplicaRequest().withDBInstanceIdentifier("mydbreadreplica").withBackupRetentionPeriod(1) .withPreferredBackupWindow("03:30-04:00"); DBInstance response = client.promoteReadReplica(request);
public DBCluster promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
Promotes a read replica DB cluster to a standalone DB cluster.
promoteReadReplicaDBCluster
in interface AmazonRDS
promoteReadReplicaDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)
Purchases a reserved DB instance offering.
purchaseReservedDBInstancesOffering
in interface AmazonRDS
purchaseReservedDBInstancesOfferingRequest
- ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.ReservedDBInstanceAlreadyExistsException
- User already has a reservation with the given identifier.ReservedDBInstanceQuotaExceededException
- Request would exceed the user's DB Instance quota.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); PurchaseReservedDBInstancesOfferingRequest request = new PurchaseReservedDBInstancesOfferingRequest().withReservedDBInstancesOfferingId( "fb29428a-646d-4390-850e-5fe89926e727").withReservedDBInstanceId("myreservationid"); ReservedDBInstance response = client.purchaseReservedDBInstancesOffering(request);
public DBCluster rebootDBCluster(RebootDBClusterRequest request)
You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
rebootDBCluster
in interface AmazonRDS
rebootDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DBInstance rebootDBInstance(RebootDBInstanceRequest request)
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the
RebootDBCluster
operation.
rebootDBInstance
in interface AmazonRDS
rebootDBInstanceRequest
- InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RebootDBInstanceRequest request = new RebootDBInstanceRequest().withDBInstanceIdentifier("mymysqlinstance").withForceFailover(false); DBInstance response = client.rebootDBInstance(request);
public RebootDBShardGroupResult rebootDBShardGroup(RebootDBShardGroupRequest request)
You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect.
This operation applies only to Aurora Limitless Database DBb shard groups.
rebootDBShardGroup
in interface AmazonRDS
rebootDBShardGroupRequest
- DBShardGroupNotFoundException
- The specified DB shard group name wasn't found.InvalidDBShardGroupStateException
- The DB shard group must be in the available state.public RegisterDBProxyTargetsResult registerDBProxyTargets(RegisterDBProxyTargetsRequest request)
Associate one or more DBProxyTarget
data structures with a DBProxyTargetGroup
.
registerDBProxyTargets
in interface AmazonRDS
registerDBProxyTargetsRequest
- DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBProxyTargetAlreadyRegisteredException
- The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBProxyStateException
- The requested operation can't be performed while the proxy is in this state.InsufficientAvailableIPsInSubnetException
- The requested operation can't be performed because there aren't enough available IP addresses in the
proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the
subnets.public GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest request)
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
This operation only applies to Aurora DB clusters.
removeFromGlobalCluster
in interface AmazonRDS
removeFromGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.public RemoveRoleFromDBClusterResult removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
removeRoleFromDBCluster
in interface AmazonRDS
removeRoleFromDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBClusterRoleNotFoundException
- The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public RemoveRoleFromDBInstanceResult removeRoleFromDBInstance(RemoveRoleFromDBInstanceRequest request)
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
removeRoleFromDBInstance
in interface AmazonRDS
removeRoleFromDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBInstanceRoleNotFoundException
- The specified RoleArn
value doesn't match the specified feature for the DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscription
in interface AmazonRDS
removeSourceIdentifierFromSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RemoveSourceIdentifierFromSubscriptionRequest request = new RemoveSourceIdentifierFromSubscriptionRequest().withSubscriptionName("myeventsubscription") .withSourceIdentifier("mymysqlinstance"); EventSubscription response = client.removeSourceIdentifierFromSubscription(request);
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
removeTagsFromResource
in interface AmazonRDS
removeTagsFromResourceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBProxyNotFoundException
- The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.DBProxyTargetGroupNotFoundException
- The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
specified Amazon Web Services Region.BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.IntegrationNotFoundException
- The specified integration could not be found.TenantDatabaseNotFoundException
- The specified tenant database wasn't found in the DB instance.DBSnapshotTenantDatabaseNotFoundException
- The specified snapshot tenant database wasn't found.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RemoveTagsFromResourceRequest request = new RemoveTagsFromResourceRequest().withResourceName("arn:aws:rds:us-east-1:992648334831:og:mydboptiongroup") .withTagKeys("MyKey"); RemoveTagsFromResourceResult response = client.removeTagsFromResource(request);
public ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
resetDBClusterParameterGroup
in interface AmazonRDS
resetDBClusterParameterGroupRequest
- InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ResetDBClusterParameterGroupRequest request = new ResetDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup") .withResetAllParameters(true); ResetDBClusterParameterGroupResult response = client.resetDBClusterParameterGroup(request);
public ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters,
provide 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
- InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you can't delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); ResetDBParameterGroupRequest request = new ResetDBParameterGroupRequest().withDBParameterGroupName("mydbparametergroup").withResetAllParameters(true); ResetDBParameterGroupResult response = client.resetDBParameterGroup(request);
public DBCluster restoreDBClusterFromS3(RestoreDBClusterFromS3Request request)
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromS3
operation has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
restoreDBClusterFromS3
in interface AmazonRDS
restoreDBClusterFromS3Request
- DBClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it's in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the
identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after
the RestoreDBClusterFromSnapshot
operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
restoreDBClusterFromSnapshot
in interface AmazonRDS
restoreDBClusterFromSnapshotRequest
- DBClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.InsufficientDBClusterCapacityException
- The DB cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.InvalidDBSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RestoreDBClusterFromSnapshotRequest request = new RestoreDBClusterFromSnapshotRequest().withDBClusterIdentifier("restored-cluster1") .withSnapshotIdentifier("sample-cluster-snapshot1").withEngine("aurora"); DBCluster response = client.restoreDBClusterFromSnapshot(request);
public DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
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 Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must
invoke the CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying
the identifier of the restored DB cluster in DBClusterIdentifier
. You can create DB instances only
after the RestoreDBClusterToPointInTime
operation has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
restoreDBClusterToPointInTime
in interface AmazonRDS
restoreDBClusterToPointInTimeRequest
- DBClusterAlreadyExistsException
- The user already has a DB cluster with the given identifier.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBClusterQuotaExceededException
- The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
cluster quota.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.InsufficientDBClusterCapacityException
- The DB cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You might be able to resolve this error
by updating your subnet group to use different Availability Zones that have more storage available.InvalidDBClusterSnapshotStateException
- The supplied value isn't a valid DB cluster snapshot state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.OptionGroupNotFoundException
- The specified option group could not be found.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.DBClusterAutomatedBackupNotFoundException
- No automated backup for this DB cluster was found.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RestoreDBClusterToPointInTimeRequest request = new RestoreDBClusterToPointInTimeRequest().withDBClusterIdentifier("sample-restored-cluster1") .withSourceDBClusterIdentifier("sample-cluster1").withRestoreToTime(new Date("2016-09-13T18:45:00Z")); DBCluster response = client.restoreDBClusterToPointInTime(request);
public DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest request)
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and 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 associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB
instance before you call the RestoreDBInstanceFromDBSnapshot
operation. RDS doesn't allow two DB
instances with the same name. After 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
operation. The result is that you 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.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterFromSnapshot
.
restoreDBInstanceFromDBSnapshot
in interface AmazonRDS
restoreDBInstanceFromDBSnapshotRequest
- DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InvalidDBSnapshotStateException
- The state of the DB snapshot doesn't allow deletion.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.BackupPolicyNotFoundException
NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.TenantDatabaseQuotaExceededException
- You attempted to create more tenant databases than are permitted in your Amazon Web Services account.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RestoreDBInstanceFromDBSnapshotRequest request = new RestoreDBInstanceFromDBSnapshotRequest().withDBInstanceIdentifier("mysqldb-restored") .withDBSnapshotIdentifier("rds:mysqldb-2014-04-22-08-15"); DBInstance response = client.restoreDBInstanceFromDBSnapshot(request);
public DBInstance restoreDBInstanceFromS3(RestoreDBInstanceFromS3Request request)
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This operation doesn't apply to RDS Custom.
restoreDBInstanceFromS3
in interface AmazonRDS
restoreDBInstanceFromS3Request
- DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.BackupPolicyNotFoundException
NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.public DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest request)
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time
identified by the LatestRestorableTime
property. You can restore to a point up to the number of days
specified by the BackupRetentionPeriod
property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
RestoreDBClusterToPointInTime
.
restoreDBInstanceToPointInTime
in interface AmazonRDS
restoreDBInstanceToPointInTimeRequest
- DBInstanceAlreadyExistsException
- The user already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InstanceQuotaExceededException
- The request would result in the user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.PointInTimeRestoreNotEnabledException
- SourceDBInstanceIdentifier
refers to a DB instance with BackupRetentionPeriod
equal to 0.StorageQuotaExceededException
- The request would result in the user exceeding the allowed amount of storage available across all DB
instances.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.InvalidRestoreException
- Cannot restore from VPC backup to non-VPC DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.DomainNotFoundException
- Domain
doesn't refer to an existing Active Directory domain.BackupPolicyNotFoundException
DBParameterGroupNotFoundException
- DBParameterGroupName
doesn't refer to an existing DB parameter group.DBInstanceAutomatedBackupNotFoundException
- No automated backup for this DB instance was found.NetworkTypeNotSupportedException
- The network type is invalid for the DB instance. Valid nework type values are IPV4
and
DUAL
.TenantDatabaseQuotaExceededException
- You attempted to create more tenant databases than are permitted in your Amazon Web Services account.CertificateNotFoundException
- CertificateIdentifier
doesn't refer to an existing certificate.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RestoreDBInstanceToPointInTimeRequest request = new RestoreDBInstanceToPointInTimeRequest().withSourceDBInstanceIdentifier("mysql-sample") .withTargetDBInstanceIdentifier("mysql-sample-restored").withRestoreTime(new Date("2016-09-13T18:45:00Z")); DBInstance response = client.restoreDBInstanceToPointInTime(request);
public DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest request)
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).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
revokeDBSecurityGroupIngress
in interface AmazonRDS
revokeDBSecurityGroupIngressRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName
doesn't refer to an existing DB security group.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
InvalidDBSecurityGroupStateException
- The state of the DB security group doesn't allow deletion.AmazonRDS client = AmazonRDSClientBuilder.standard().build(); RevokeDBSecurityGroupIngressRequest request = new RevokeDBSecurityGroupIngressRequest().withDBSecurityGroupName("mydbsecuritygroup").withCIDRIP( "203.0.113.5/32"); DBSecurityGroup response = client.revokeDBSecurityGroupIngress(request);
public StartActivityStreamResult startActivityStream(StartActivityStreamRequest request)
Starts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
startActivityStream
in interface AmazonRDS
startActivityStreamRequest
- InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.ResourceNotFoundException
- The specified resource ID was not found.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.public DBCluster startDBCluster(StartDBClusterRequest request)
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
CLI command, or the StopDBCluster
operation.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
startDBCluster
in interface AmazonRDS
startDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DBInstance startDBInstance(StartDBInstanceRequest request)
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI
command, or the StopDBInstance
operation.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use
StartDBCluster
instead.
startDBInstance
in interface AmazonRDS
startDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InsufficientDBInstanceCapacityException
- The specified DB instance class isn't available in the specified Availability Zone.DBSubnetGroupNotFoundException
- DBSubnetGroupName
doesn't refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.AuthorizationNotFoundException
- The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB
security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.
KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.public DBInstanceAutomatedBackup startDBInstanceAutomatedBackupsReplication(StartDBInstanceAutomatedBackupsReplicationRequest request)
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
startDBInstanceAutomatedBackupsReplication
in interface AmazonRDS
startDBInstanceAutomatedBackupsReplicationRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.DBInstanceAutomatedBackupQuotaExceededException
- The quota for retained automated backups was exceeded. This prevents you from retaining any additional
automated backups. The retained automated backups quota is the same as your DB instance quota.StorageTypeNotSupportedException
- The specified StorageType
can't be associated with the DB instance.public StartExportTaskResult startExportTask(StartExportTaskRequest request)
Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.
You can't export snapshot data from Db2 or RDS Custom DB instances.
For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.
startExportTask
in interface AmazonRDS
startExportTaskRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.ExportTaskAlreadyExistsException
- You can't start an export task that's already running.InvalidS3BucketException
- The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified
Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try
again.IamRoleNotFoundException
- The IAM role is missing for exporting to an Amazon S3 bucket.IamRoleMissingPermissionsException
- The IAM role requires additional permissions to export to an Amazon S3 bucket.InvalidExportOnlyException
- The export is invalid for exporting to an Amazon S3 bucket.KMSKeyNotAccessibleException
- An error occurred accessing an Amazon Web Services KMS key.InvalidExportSourceStateException
- The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.public StopActivityStreamResult stopActivityStream(StopActivityStreamRequest request)
Stops a database activity stream that was started using the Amazon Web Services console, the
start-activity-stream
CLI command, or the StartActivityStream
operation.
For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.
stopActivityStream
in interface AmazonRDS
stopActivityStreamRequest
- InvalidDBInstanceStateException
- The DB instance isn't in a valid state.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.ResourceNotFoundException
- The specified resource ID was not found.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.public DBCluster stopDBCluster(StopDBClusterRequest request)
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
stopDBCluster
in interface AmazonRDS
stopDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public DBInstance stopDBInstance(StopDBInstanceRequest request)
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use
StopDBCluster
instead.
stopDBInstance
in interface AmazonRDS
stopDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier
is already used by an existing snapshot.SnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of DB snapshots.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.public DBInstanceAutomatedBackup stopDBInstanceAutomatedBackupsReplication(StopDBInstanceAutomatedBackupsReplicationRequest request)
Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
stopDBInstanceAutomatedBackupsReplication
in interface AmazonRDS
stopDBInstanceAutomatedBackupsReplicationRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.public SwitchoverBlueGreenDeploymentResult switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request)
Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
switchoverBlueGreenDeployment
in interface AmazonRDS
switchoverBlueGreenDeploymentRequest
- BlueGreenDeploymentNotFoundException
- BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.InvalidBlueGreenDeploymentStateException
- The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
the green environment.public GlobalCluster switchoverGlobalCluster(SwitchoverGlobalClusterRequest request)
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.
This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.
switchoverGlobalCluster
in interface AmazonRDS
switchoverGlobalClusterRequest
- GlobalClusterNotFoundException
- The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.InvalidGlobalClusterStateException
- The global cluster is in an invalid state and can't perform the requested operation.InvalidDBClusterStateException
- The requested operation can't be performed while the cluster is in this state.DBClusterNotFoundException
- DBClusterIdentifier
doesn't refer to an existing DB cluster.public DBInstance switchoverReadReplica(SwitchoverReadReplicaRequest request)
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
switchoverReadReplica
in interface AmazonRDS
switchoverReadReplicaRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier
doesn't refer to an existing DB instance.InvalidDBInstanceStateException
- The DB instance isn't in a valid state.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 requestpublic AmazonRDSWaiters waiters()
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonRDS
shutdown
in class AmazonWebServiceClient