@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, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
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 from an Aurora DB cluster.
|
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.
|
static AmazonRDSClientBuilder |
builder() |
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.
|
DBCluster |
createDBCluster(CreateDBClusterRequest request)
Creates a new 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.
|
DBParameterGroup |
createDBParameterGroup(CreateDBParameterGroupRequest request)
Creates a new DB parameter group.
|
DBSecurityGroup |
createDBSecurityGroup(CreateDBSecurityGroupRequest request)
Creates a new DB security group.
|
DBSnapshot |
createDBSnapshot(CreateDBSnapshotRequest request)
Creates a DBSnapshot.
|
DBSubnetGroup |
createDBSubnetGroup(CreateDBSubnetGroupRequest request)
Creates a new DB subnet group.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an RDS event notification subscription.
|
OptionGroup |
createOptionGroup(CreateOptionGroupRequest request)
Creates a new option group.
|
DBCluster |
deleteDBCluster(DeleteDBClusterRequest request)
The DeleteDBCluster action deletes a previously provisioned 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)
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
DeleteDBParameterGroupResult |
deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Deletes a specified DBParameterGroup.
|
DeleteDBSecurityGroupResult |
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
Deletes a DB security group.
|
DBSnapshot |
deleteDBSnapshot(DeleteDBSnapshotRequest request)
Deletes a DBSnapshot.
|
DeleteDBSubnetGroupResult |
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
Deletes a DB subnet group.
|
EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an RDS event notification subscription.
|
DeleteOptionGroupResult |
deleteOptionGroup(DeleteOptionGroupRequest request)
Deletes an existing option group.
|
DescribeAccountAttributesResult |
describeAccountAttributes()
Simplified method form for invoking the DescribeAccountAttributes operation.
|
DescribeAccountAttributesResult |
describeAccountAttributes(DescribeAccountAttributesRequest request)
Lists all of the attributes for a customer account.
|
DescribeCertificatesResult |
describeCertificates()
Simplified method form for invoking the DescribeCertificates operation.
|
DescribeCertificatesResult |
describeCertificates(DescribeCertificatesRequest request)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
|
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups()
Simplified method form for invoking the DescribeDBClusterParameterGroups operation.
|
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest 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)
Returns information about provisioned Aurora 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)
Returns a list of the available DB engines.
|
DescribeDBInstancesResult |
describeDBInstances()
Simplified method form for invoking the DescribeDBInstances operation.
|
DescribeDBInstancesResult |
describeDBInstances(DescribeDBInstancesRequest request)
Returns information about 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.
|
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups()
Simplified method form for invoking the DescribeDBSecurityGroups operation.
|
DescribeDBSecurityGroupsResult |
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest request)
Returns a list of
DBSecurityGroup descriptions. |
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.
|
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 security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions()
Simplified method form for invoking the DescribeEventSubscriptions operation.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists all the subscription descriptions for a customer account.
|
DescribeOptionGroupOptionsResult |
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
Describes all available options.
|
DescribeOptionGroupsResult |
describeOptionGroups()
Simplified method form for invoking the DescribeOptionGroups operation.
|
DescribeOptionGroupsResult |
describeOptionGroups(DescribeOptionGroupsRequest request)
Describes the available option groups.
|
DescribeOrderableDBInstanceOptionsResult |
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
Returns a list of orderable DB instance options for the specified engine.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions()
Simplified method form for invoking the DescribePendingMaintenanceActions operation.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest 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 AWS regions where the current AWS Region can create a Read Replica or copy a DB
snapshot from.
|
ValidDBInstanceModificationsMessage |
describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB
instance.
|
DownloadDBLogFilePortionResult |
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
Downloads all or a portion of the specified log file, up to 1 MB in size.
|
DBCluster |
failoverDBCluster()
Simplified method form for invoking the FailoverDBCluster operation.
|
DBCluster |
failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on an Amazon RDS resource.
|
DBCluster |
modifyDBCluster(ModifyDBClusterRequest request)
Modify a setting for 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.
|
DBSnapshot |
modifyDBSnapshot(ModifyDBSnapshotRequest request)
Updates a manual DB snapshot, which can be encrypted or not encrypted, 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.
|
OptionGroup |
modifyOptionGroup(ModifyOptionGroupRequest request)
Modifies an existing option group.
|
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.
|
DBInstance |
rebootDBInstance(RebootDBInstanceRequest request)
Rebooting a DB instance restarts the database engine service.
|
RemoveRoleFromDBClusterResult |
removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster.
|
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 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 |
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.
|
DBInstance |
startDBInstance(StartDBInstanceRequest request)
Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the
StopDBInstance action.
|
DBInstance |
stopDBInstance(StopDBInstanceRequest request)
Stops a DB instance.
|
AmazonRDSWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, 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 from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
addRoleToDBCluster
in interface AmazonRDS
addRoleToDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not 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 DB cluster is not in a valid state.DBClusterRoleQuotaExceededException
- You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.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 = new AmazonRDSClient(); AddSourceIdentifierToSubscriptionRequest request = new AddSourceIdentifierToSubscriptionRequest() .withSourceIdentifier("mymysqlinstance").withSubscriptionName( "mymysqleventsubscription"); 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 Amazon RDS resources, see Tagging Amazon RDS Resources.
addTagsToResource
in interface AmazonRDS
addTagsToResourceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.AmazonRDS client = new AmazonRDSClient(); 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.AmazonRDS client = new AmazonRDSClient(); ApplyPendingMaintenanceActionRequest request = new ApplyPendingMaintenanceActionRequest() .withApplyAction("system-update") .withOptInType("immediate") .withResourceIdentifier( "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"); 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 cannot authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
authorizeDBSecurityGroupIngress
in interface AmazonRDS
authorizeDBSecurityGroupIngressRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.AuthorizationAlreadyExistsException
- The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.AuthorizationQuotaExceededException
- DB security group authorization quota has been reached.AmazonRDS client = new AmazonRDSClient(); AuthorizeDBSecurityGroupIngressRequest request = new AuthorizeDBSecurityGroupIngressRequest() .withCIDRIP("203.0.113.5/32").withDBSecurityGroupName( "mydbsecuritygroup"); DBSecurityGroup response = client .authorizeDBSecurityGroupIngress(request);
public DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
Copies the specified DB cluster parameter group.
copyDBClusterParameterGroup
in interface AmazonRDS
copyDBClusterParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.AmazonRDS client = new AmazonRDSClient(); CopyDBClusterParameterGroupRequest request = new CopyDBClusterParameterGroupRequest() .withSourceDBClusterParameterGroupIdentifier( "mydbclusterparametergroup") .withTargetDBClusterParameterGroupDescription( "My DB cluster parameter group copy") .withTargetDBClusterParameterGroupIdentifier( "mydbclusterparametergroup-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 AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot
action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId
- The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy
of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot
API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot
action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your
SourceDBClusterSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
the destination AWS 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 AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier
in the pre-signed 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 DB cluster snapshots from one AWS Region to another, see Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
copyDBClusterSnapshot
in interface AmazonRDS
copyDBClusterSnapshotRequest
- DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.KMSKeyNotAccessibleException
- Error accessing KMS key.AmazonRDS client = new AmazonRDSClient(); CopyDBClusterSnapshotRequest request = new CopyDBClusterSnapshotRequest() .withSourceDBClusterSnapshotIdentifier("mydbclustersnapshot") .withTargetDBClusterSnapshotIdentifier( "mydbclustersnapshot-copy"); DBClusterSnapshot response = client.copyDBClusterSnapshot(request);
public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest request)
Copies the specified DB parameter group.
copyDBParameterGroup
in interface AmazonRDS
copyDBParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.AmazonRDS client = new AmazonRDSClient(); CopyDBParameterGroupRequest request = new CopyDBParameterGroupRequest() .withSourceDBParameterGroupIdentifier("mymysqlparametergroup") .withTargetDBParameterGroupDescription( "My MySQL parameter group copy") .withTargetDBParameterGroupIdentifier( "mymysqlparametergroup-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 AWS Region to another. In that case, the AWS Region where you call the
CopyDBSnapshot
action is the destination AWS Region for the DB snapshot copy.
You cannot copy an encrypted, shared DB snapshot from one AWS Region to another.
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 does not refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.KMSKeyNotAccessibleException
- Error accessing KMS key.AmazonRDS client = new AmazonRDSClient(); 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 AWS account.AmazonRDS client = new AmazonRDSClient(); CopyOptionGroupRequest request = new CopyOptionGroupRequest() .withSourceOptionGroupIdentifier("mymysqloptiongroup") .withTargetOptionGroupDescription("My MySQL option group copy") .withTargetOptionGroupIdentifier("mymysqloptiongroup-copy"); OptionGroup response = client.copyOptionGroup(request);
public DBCluster createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier
parameter to create the DB cluster as a Read Replica of
another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified
by ReplicationSourceIdentifier
is encrypted, you must also specify the PreSignedUrl
parameter.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBCluster
in interface AmazonRDS
createDBClusterRequest
- DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster
quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.KMSKeyNotAccessibleException
- Error accessing KMS key.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.DBInstanceNotFoundException
- DBInstanceIdentifier does not 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.AmazonRDS client = new AmazonRDSClient(); CreateDBClusterRequest request = new CreateDBClusterRequest() .withAvailabilityZones("us-east-1a") .withBackupRetentionPeriod(1) .withDBClusterIdentifier("mydbcluster") .withDBClusterParameterGroupName("mydbclusterparametergroup") .withDatabaseName("myauroradb").withEngine("aurora") .withEngineVersion("5.6.10a") .withMasterUserPassword("mypassword") .withMasterUsername("myuser").withPort(3306) .withStorageEncrypted(true); DBCluster response = client.createDBCluster(request);
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 DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully
complete the create action before the DB cluster parameter group is used as the default for a new DB cluster.
This is especially important for parameters that are critical when creating the default database for a DB
cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
command to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterParameterGroup
in interface AmazonRDS
createDBClusterParameterGroupRequest
- DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.AmazonRDS client = new AmazonRDSClient(); 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterSnapshot
in interface AmazonRDS
createDBClusterSnapshotRequest
- DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.InvalidDBClusterStateException
- The DB cluster is not in a valid state.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.AmazonRDS client = new AmazonRDSClient(); CreateDBClusterSnapshotRequest request = new CreateDBClusterSnapshotRequest() .withDBClusterIdentifier("mydbcluster") .withDBClusterSnapshotIdentifier("mydbclustersnapshot"); DBClusterSnapshot response = client.createDBClusterSnapshot(request);
public DBInstance createDBInstance(CreateDBInstanceRequest request)
Creates a new DB instance.
createDBInstance
in interface AmazonRDS
createDBInstanceRequest
- DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DomainNotFoundException
- Domain does not refer to an existing Active Directory Domain.AmazonRDS client = new AmazonRDSClient(); CreateDBInstanceRequest request = new CreateDBInstanceRequest() .withAllocatedStorage(5).withDBInstanceClass("db.t2.micro") .withDBInstanceIdentifier("mymysqlinstance") .withEngine("MySQL").withMasterUserPassword("MyPassword") .withMasterUsername("MyUser"); 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. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL.
Amazon Aurora does not support this action. You must call the CreateDBInstance
action to create a DB
instance for an Aurora DB cluster.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.
createDBInstanceReadReplica
in interface AmazonRDS
createDBInstanceReadReplicaRequest
- DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBSubnetGroupNotAllowedException
- Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the
same region as the source instance.InvalidDBSubnetGroupException
- Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read
replica of the same source instance.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.KMSKeyNotAccessibleException
- Error accessing KMS key.AmazonRDS client = new AmazonRDSClient(); CreateDBInstanceReadReplicaRequest request = new CreateDBInstanceReadReplicaRequest() .withAvailabilityZone("us-east-1a") .withCopyTagsToSnapshot(true) .withDBInstanceClass("db.t2.micro") .withDBInstanceIdentifier("mydbreadreplica") .withPubliclyAccessible(true) .withSourceDBInstanceIdentifier("mymysqlinstance") .withStorageType("gp2") .withTags( new Tag().withKey("mydbreadreplicakey").withValue( "mydbreadreplicavalue")); 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.
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
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.AmazonRDS client = new AmazonRDSClient(); CreateDBParameterGroupRequest request = new CreateDBParameterGroupRequest() .withDBParameterGroupFamily("mysql5.6") .withDBParameterGroupName("mymysqlparametergroup") .withDescription("My MySQL parameter group"); DBParameterGroup response = client.createDBParameterGroup(request);
public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest request)
Creates a new DB security group. DB security groups control access to a DB instance.
createDBSecurityGroup
in interface AmazonRDS
createDBSecurityGroupRequest
- DBSecurityGroupAlreadyExistsException
- A DB security group with the name specified in DBSecurityGroupName already exists.DBSecurityGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB security groups.DBSecurityGroupNotSupportedException
- A DB security group is not allowed for this action.AmazonRDS client = new AmazonRDSClient(); CreateDBSecurityGroupRequest request = new CreateDBSecurityGroupRequest() .withDBSecurityGroupDescription("My DB security group") .withDBSecurityGroupName("mydbsecuritygroup"); DBSecurityGroup response = client.createDBSecurityGroup(request);
public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest request)
Creates a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshot
in interface AmazonRDS
createDBSnapshotRequest
- DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.AmazonRDS client = new AmazonRDSClient(); CreateDBSnapshotRequest request = new CreateDBSnapshotRequest() .withDBInstanceIdentifier("mymysqlinstance") .withDBSnapshotIdentifier("mydbsnapshot"); 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 AWS Region.
createDBSubnetGroup
in interface AmazonRDS
createDBSubnetGroupRequest
- DBSubnetGroupAlreadyExistsException
- DBSubnetGroupName is already used by an existing DB subnet group.DBSubnetGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB subnet groups.DBSubnetQuotaExceededException
- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.AmazonRDS client = new AmazonRDSClient(); CreateDBSubnetGroupRequest request = new CreateDBSubnetGroupRequest() .withDBSubnetGroupDescription("My DB subnet group") .withDBSubnetGroupName("mydbsubnetgroup") .withSubnetIds("subnet-1fab8a69", "subnet-d43a468c"); DBSubnetGroup response = client.createDBSubnetGroup(request);
public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.
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 SND topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SourceNotFoundException
- The requested source could not be found.AmazonRDS client = new AmazonRDSClient(); CreateEventSubscriptionRequest request = new CreateEventSubscriptionRequest() .withEnabled(true) .withEventCategories("availability") .withSnsTopicArn( "arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic") .withSourceIds("mymysqlinstance").withSourceType("db-instance") .withSubscriptionName("mymysqleventsubscription"); EventSubscription response = client.createEventSubscription(request);
public OptionGroup createOptionGroup(CreateOptionGroupRequest request)
Creates a new option group. You can create up to 20 option groups.
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 AWS account.AmazonRDS client = new AmazonRDSClient(); CreateOptionGroupRequest request = new CreateOptionGroupRequest() .withEngineName("MySQL").withMajorEngineVersion("5.6") .withOptionGroupDescription("My MySQL 5.6 option group") .withOptionGroupName("mymysqloptiongroup"); OptionGroup response = client.createOptionGroup(request);
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 cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBCluster
in interface AmazonRDS
deleteDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDBClusterStateException
- The DB cluster is not in a valid state.DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.AmazonRDS client = new AmazonRDSClient(); DeleteDBClusterRequest request = new DeleteDBClusterRequest() .withDBClusterIdentifier("mydbcluster").withSkipFinalSnapshot( true); DBCluster response = client.deleteDBCluster(request);
public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterParameterGroup
in interface AmazonRDS
deleteDBClusterParameterGroupRequest
- InvalidDBParameterGroupStateException
- The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter
group, you cannot delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterSnapshot
in interface AmazonRDS
deleteDBClusterSnapshotRequest
- InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.AmazonRDS client = new AmazonRDSClient(); DeleteDBClusterSnapshotRequest request = new DeleteDBClusterSnapshotRequest() .withDBClusterSnapshotIdentifier("mydbclustersnapshot"); DBClusterSnapshot response = client.deleteDBClusterSnapshot(request);
public DBInstance deleteDBInstance(DeleteDBInstanceRequest request)
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all
automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance
to be deleted by DeleteDBInstance
are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting
until the DB
snapshot is created. The API action DescribeDBInstance
is used to monitor the status of this
operation. The action cannot be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of failed
,
incompatible-restore
, or incompatible-network
, you can only delete it when the
SkipFinalSnapshot
parameter is set to true
.
If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot 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 call the PromoteReadReplicaDBCluster API action to promote the
DB cluster so it's no longer a Read Replica. After the promotion completes, then call the
DeleteDBInstance
API action to delete the final instance in the DB cluster.
deleteDBInstance
in interface AmazonRDS
deleteDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterStateException
- The DB cluster is not in a valid state.AmazonRDS client = new AmazonRDSClient(); DeleteDBInstanceRequest request = new DeleteDBInstanceRequest() .withDBInstanceIdentifier("mymysqlinstance") .withSkipFinalSnapshot(true); DBInstance response = client.deleteDBInstance(request);
public DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot 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 cannot delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.public DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest request)
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroup
in interface AmazonRDS
deleteDBSecurityGroupRequest
- InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest request)
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
The DBSnapshot must be in the available
state to be deleted.
deleteDBSnapshot
in interface AmazonRDS
deleteDBSnapshotRequest
- InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.AmazonRDS client = new AmazonRDSClient(); 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 is in use.InvalidDBSubnetStateException
- The DB subnet is not in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.AmazonRDS client = new AmazonRDSClient(); 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 = new AmazonRDSClient(); DeleteEventSubscriptionRequest request = new DeleteEventSubscriptionRequest() .withSubscriptionName("myeventsubscription"); EventSubscription response = client.deleteEventSubscription(request);
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 is not in the available state.AmazonRDS client = new AmazonRDSClient(); DeleteOptionGroupRequest request = new DeleteOptionGroupRequest() .withOptionGroupName("mydboptiongroup"); DeleteOptionGroupResult response = client.deleteOptionGroup(request);
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 does not take any parameters.
describeAccountAttributes
in interface AmazonRDS
describeAccountAttributesRequest
- AmazonRDS client = new AmazonRDSClient(); DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest(); DescribeAccountAttributesResult response = client .describeAccountAttributes(request);
public DescribeAccountAttributesResult describeAccountAttributes()
AmazonRDS
describeAccountAttributes
in interface AmazonRDS
AmazonRDS.describeAccountAttributes(DescribeAccountAttributesRequest)
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificates
in interface AmazonRDS
describeCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier does not refer to an existing certificate.AmazonRDS client = new AmazonRDSClient(); 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 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParameterGroups
in interface AmazonRDS
describeDBClusterParameterGroupsRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParameters
in interface AmazonRDS
describeDBClusterParametersRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); 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 AWS accounts, DescribeDBClusterSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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 does not refer to an existing DB cluster snapshot.AmazonRDS client = new AmazonRDSClient(); 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, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterSnapshots
in interface AmazonRDS
describeDBClusterSnapshotsRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.AmazonRDS client = new AmazonRDSClient(); 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)
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusters
in interface AmazonRDS
describeDBClustersRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.AmazonRDS client = new AmazonRDSClient(); 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)
Returns a list of the available DB engines.
describeDBEngineVersions
in interface AmazonRDS
describeDBEngineVersionsRequest
- AmazonRDS client = new AmazonRDSClient(); DescribeDBEngineVersionsRequest request = new DescribeDBEngineVersionsRequest() .withDBParameterGroupFamily("mysql5.6").withDefaultOnly(true) .withEngine("mysql").withEngineVersion("5.6") .withListSupportedCharacterSets(true); DescribeDBEngineVersionsResult response = client .describeDBEngineVersions(request);
public DescribeDBEngineVersionsResult describeDBEngineVersions()
AmazonRDS
describeDBEngineVersions
in interface AmazonRDS
AmazonRDS.describeDBEngineVersions(DescribeDBEngineVersionsRequest)
public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstances
in interface AmazonRDS
describeDBInstancesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.AmazonRDS client = new AmazonRDSClient(); 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.
describeDBLogFiles
in interface AmazonRDS
describeDBLogFilesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.AmazonRDS client = new AmazonRDSClient(); DescribeDBLogFilesRequest request = new DescribeDBLogFilesRequest() .withDBInstanceIdentifier("mymysqlinstance") .withFileLastWritten(1470873600000L).withFileSize(0L) .withFilenameContains("error"); 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 does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); 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 does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); DescribeDBParametersRequest request = new DescribeDBParametersRequest() .withDBParameterGroupName("mymysqlparametergroup") .withMaxRecords(20).withSource("system"); DescribeDBParametersResult response = client .describeDBParameters(request);
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.
describeDBSecurityGroups
in interface AmazonRDS
describeDBSecurityGroupsRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.AmazonRDS client = new AmazonRDSClient(); DescribeDBSecurityGroupsRequest request = new DescribeDBSecurityGroupsRequest() .withDBSecurityGroupName("mydbsecuritygroup"); DescribeDBSecurityGroupsResult response = client .describeDBSecurityGroups(request);
public DescribeDBSecurityGroupsResult describeDBSecurityGroups()
AmazonRDS
describeDBSecurityGroups
in interface AmazonRDS
AmazonRDS.describeDBSecurityGroups(DescribeDBSecurityGroupsRequest)
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 AWS accounts, DescribeDBSnapshotAttributes
returns the
restore
attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
describeDBSnapshotAttributes
in interface AmazonRDS
describeDBSnapshotAttributesRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.AmazonRDS client = new AmazonRDSClient(); DescribeDBSnapshotAttributesRequest request = new DescribeDBSnapshotAttributesRequest() .withDBSnapshotIdentifier("mydbsnapshot"); DBSnapshotAttributesResult response = client .describeDBSnapshotAttributes(request);
public DBSnapshotAttributesResult describeDBSnapshotAttributes()
AmazonRDS
describeDBSnapshotAttributes
in interface AmazonRDS
AmazonRDS.describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)
public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest request)
Returns information about DB snapshots. This API action supports pagination.
describeDBSnapshots
in interface AmazonRDS
describeDBSnapshotsRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.AmazonRDS client = new AmazonRDSClient(); DescribeDBSnapshotsRequest request = new DescribeDBSnapshotsRequest() .withDBInstanceIdentifier("mymysqlinstance") .withIncludePublic(true).withIncludeShared(true) .withSnapshotType("manual"); 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 does not refer to an existing DB subnet group.AmazonRDS client = new AmazonRDSClient(); 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 Aurora on Amazon RDS in the Amazon RDS User Guide.
describeEngineDefaultClusterParameters
in interface AmazonRDS
describeEngineDefaultClusterParametersRequest
- AmazonRDS client = new AmazonRDSClient(); 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 = new AmazonRDSClient(); 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 see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
describeEventCategories
in interface AmazonRDS
describeEventCategoriesRequest
- AmazonRDS client = new AmazonRDSClient(); 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 = new AmazonRDSClient(); 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 security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEvents
in interface AmazonRDS
describeEventsRequest
- AmazonRDS client = new AmazonRDSClient(); DescribeEventsRequest request = new DescribeEventsRequest() .withDuration(10080).withEventCategories("backup") .withSourceIdentifier("mymysqlinstance") .withSourceType("db-instance"); DescribeEventsResult response = client.describeEvents(request);
public DescribeEventsResult describeEvents()
AmazonRDS
describeEvents
in interface AmazonRDS
AmazonRDS.describeEvents(DescribeEventsRequest)
public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)
Describes all available options.
describeOptionGroupOptions
in interface AmazonRDS
describeOptionGroupOptionsRequest
- AmazonRDS client = new AmazonRDSClient(); 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 = new AmazonRDSClient(); 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)
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptions
in interface AmazonRDS
describeOrderableDBInstanceOptionsRequest
- AmazonRDS client = new AmazonRDSClient(); DescribeOrderableDBInstanceOptionsRequest request = new DescribeOrderableDBInstanceOptionsRequest() .withDBInstanceClass("db.t2.micro").withEngine("mysql") .withEngineVersion("5.6.27") .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.
describePendingMaintenanceActions
in interface AmazonRDS
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The specified resource ID was not found.AmazonRDS client = new AmazonRDSClient(); 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 = new AmazonRDSClient(); DescribeReservedDBInstancesRequest request = new DescribeReservedDBInstancesRequest() .withDBInstanceClass("db.t2.micro").withDuration("1y") .withMultiAZ(false).withOfferingType("No Upfront") .withProductDescription("mysql"); 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 = new AmazonRDSClient(); DescribeReservedDBInstancesOfferingsRequest request = new DescribeReservedDBInstancesOfferingsRequest() .withDBInstanceClass("db.t2.micro").withDuration("1y") .withMultiAZ(false).withOfferingType("No Upfront") .withProductDescription("mysql"); 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 AWS regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
describeSourceRegions
in interface AmazonRDS
describeSourceRegionsRequest
- 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.
describeValidDBInstanceModifications
in interface AmazonRDS
describeValidDBInstanceModificationsRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)
Downloads all or a portion of the specified log file, up to 1 MB in size.
downloadDBLogFilePortion
in interface AmazonRDS
downloadDBLogFilePortionRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBLogFileNotFoundException
- LogFileName does not refer to an existing DB log file.AmazonRDS client = new AmazonRDSClient(); DownloadDBLogFilePortionRequest request = new DownloadDBLogFilePortionRequest() .withDBInstanceIdentifier("mymysqlinstance").withLogFileName( "mysqlUpgrade"); DownloadDBLogFilePortionResult response = client .downloadDBLogFilePortion(request);
public DBCluster failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
failoverDBCluster
in interface AmazonRDS
failoverDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.AmazonRDS client = new AmazonRDSClient(); 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 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.
listTagsForResource
in interface AmazonRDS
listTagsForResourceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.AmazonRDS client = new AmazonRDSClient(); ListTagsForResourceRequest request = new ListTagsForResourceRequest() .withResourceName("arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"); ListTagsForResourceResult response = client .listTagsForResource(request);
public DBCluster modifyDBCluster(ModifyDBClusterRequest request)
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
modifyDBCluster
in interface AmazonRDS
modifyDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDBClusterStateException
- The DB cluster is not in a valid state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.AmazonRDS client = new AmazonRDSClient(); ModifyDBClusterRequest request = new ModifyDBClusterRequest() .withApplyImmediately(true) .withDBClusterIdentifier("mydbcluster") .withMasterUserPassword("mynewpassword") .withNewDBClusterIdentifier("mynewdbcluster") .withPreferredBackupWindow("04:00-04:30") .withPreferredMaintenanceWindow("Tue:05:00-Tue:05:30"); DBCluster response = client.modifyDBCluster(request);
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.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully
complete the create action before the parameter group is used as the default for a new DB cluster. This is
especially important for parameters that are critical when creating the default database for a DB cluster, such
as the character set for the default database defined by the character_set_database
parameter. You
can use the Parameter Groups option of the Amazon RDS
console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has
been created or modified.
modifyDBClusterParameterGroup
in interface AmazonRDS
modifyDBClusterParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not 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 cannot delete it when the parameter group is in this state.AmazonRDS client = new AmazonRDSClient(); ModifyDBClusterParameterGroupRequest request = new ModifyDBClusterParameterGroupRequest() .withDBClusterParameterGroupName("mydbclusterparametergroup") .withParameters( new Parameter().withApplyMethod("immediate") .withParameterName("time_zone") .withParameterValue("America/Phoenix")); 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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS accounts. Do not
add the all
value for any manual DB cluster snapshots that contain private information that you
don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd
parameter. You can't use
all
as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
modifyDBClusterSnapshotAttribute
in interface AmazonRDS
modifyDBClusterSnapshotAttributeRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.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 specified DB instance is not in the available state.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBUpgradeDependencyFailureException
- The DB upgrade failed because a resource the DB depends on could not be modified.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
CertificateNotFoundException
- CertificateIdentifier does not refer to an existing certificate.DomainNotFoundException
- Domain does not refer to an existing Active Directory Domain.AmazonRDS client = new AmazonRDSClient(); ModifyDBInstanceRequest request = new ModifyDBInstanceRequest() .withAllocatedStorage(10).withApplyImmediately(true) .withBackupRetentionPeriod(1) .withDBInstanceClass("db.t2.small") .withDBInstanceIdentifier("mymysqlinstance") .withMasterUserPassword("mynewpassword") .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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the
modify action before the parameter group is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default database for a DB instance, such as the
character set for the default database defined by the character_set_database
parameter. You can use
the Parameter Groups option of the Amazon RDS console or
the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
modifyDBParameterGroup
in interface AmazonRDS
modifyDBParameterGroupRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not 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 cannot delete it when the parameter group is in this state.AmazonRDS client = new AmazonRDSClient(); ModifyDBParameterGroupRequest request = new ModifyDBParameterGroupRequest() .withDBParameterGroupName("mymysqlparametergroup") .withParameters( new Parameter().withApplyMethod("immediate") .withParameterName("time_zone") .withParameterValue("America/Phoenix")); ModifyDBParameterGroupResult response = client .modifyDBParameterGroup(request);
public DBSnapshot modifyDBSnapshot(ModifyDBSnapshotRequest request)
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.
modifyDBSnapshot
in interface AmazonRDS
modifyDBSnapshotRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not 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 AWS accounts, specify restore
as the
AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the AWS
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 AWS accounts. Do not add the
all
value for any manual DB snapshots that contain private information that you don't want available
to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of
authorized AWS account IDs for the ValuesToAdd
parameter. You can't use all
as a value
for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.
modifyDBSnapshotAttribute
in interface AmazonRDS
modifyDBSnapshotAttributeRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.AmazonRDS client = new AmazonRDSClient(); ModifyDBSnapshotAttributeRequest request = new ModifyDBSnapshotAttributeRequest() .withAttributeName("restore") .withDBSnapshotIdentifier("mydbsnapshot") .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 AWS Region.
modifyDBSubnetGroup
in interface AmazonRDS
modifyDBSubnetGroupRequest
- DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetQuotaExceededException
- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException
- The DB subnet is already in use in the Availability Zone.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.AmazonRDS client = new AmazonRDSClient(); 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. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
modifyEventSubscription
in interface AmazonRDS
modifyEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException
- The subscription name does not exist.SNSInvalidTopicException
- SNS has responded that there is a problem with the SND topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.AmazonRDS client = new AmazonRDSClient(); ModifyEventSubscriptionRequest request = new ModifyEventSubscriptionRequest() .withEnabled(true) .withEventCategories("deletion", "low storage") .withSourceType("db-instance") .withSubscriptionName("mymysqleventsubscription"); EventSubscription response = client.modifyEventSubscription(request);
public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest request)
Modifies an existing option group.
modifyOptionGroup
in interface AmazonRDS
modifyOptionGroupRequest
- InvalidOptionGroupStateException
- The option group is not in the available state.OptionGroupNotFoundException
- The specified option group could not be found.public DBInstance promoteReadReplica(PromoteReadReplicaRequest request)
Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
promoteReadReplica
in interface AmazonRDS
promoteReadReplicaRequest
- InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.AmazonRDS client = new AmazonRDSClient(); PromoteReadReplicaRequest request = new PromoteReadReplicaRequest() .withBackupRetentionPeriod(1) .withDBInstanceIdentifier("mydbreadreplica") .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 does not refer to an existing DB cluster.InvalidDBClusterStateException
- The DB cluster is not in a valid 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 = new AmazonRDSClient(); PurchaseReservedDBInstancesOfferingRequest request = new PurchaseReservedDBInstancesOfferingRequest() .withReservedDBInstanceId("myreservationid") .withReservedDBInstancesOfferingId( "fb29428a-646d-4390-850e-5fe89926e727"); ReservedDBInstance response = client .purchaseReservedDBInstancesOffering(request);
public DBInstance rebootDBInstance(RebootDBInstanceRequest request)
Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot is conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
rebootDBInstance
in interface AmazonRDS
rebootDBInstanceRequest
- InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.AmazonRDS client = new AmazonRDSClient(); RebootDBInstanceRequest request = new RebootDBInstanceRequest() .withDBInstanceIdentifier("mymysqlinstance").withForceFailover( false); DBInstance response = client.rebootDBInstance(request);
public RemoveRoleFromDBClusterResult removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
removeRoleFromDBCluster
in interface AmazonRDS
removeRoleFromDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.DBClusterRoleNotFoundException
- The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.InvalidDBClusterStateException
- The DB cluster is not 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 = new AmazonRDSClient(); RemoveSourceIdentifierFromSubscriptionRequest request = new RemoveSourceIdentifierFromSubscriptionRequest() .withSourceIdentifier("mymysqlinstance").withSubscriptionName( "myeventsubscription"); 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.
removeTagsFromResource
in interface AmazonRDS
removeTagsFromResourceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.AmazonRDS client = new AmazonRDSClient(); 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, see Aurora on Amazon RDS 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 cannot delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); 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 cannot delete it when the parameter group is in this state.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.AmazonRDS client = new AmazonRDSClient(); 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 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.
restoreDBClusterFromS3
in interface AmazonRDS
restoreDBClusterFromS3Request
- DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster
quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidS3BucketException
- The specified Amazon S3 bucket name could not be found or Amazon RDS is not authorized to access the
specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and
try again.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.KMSKeyNotAccessibleException
- Error accessing KMS key.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterFromSnapshot
in interface AmazonRDS
restoreDBClusterFromSnapshotRequest
- DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster
quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.InsufficientDBClusterCapacityException
- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KMSKeyNotAccessibleException
- Error accessing KMS key.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.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance action 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
action has completed and the DB cluster is available.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterToPointInTime
in interface AmazonRDS
restoreDBClusterToPointInTimeRequest
- DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster
quota.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InsufficientDBClusterCapacityException
- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidDBSnapshotStateException
- The state of the DB snapshot does not 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
- DB subnet group does not cover all Availability Zones after it is created because users' change.KMSKeyNotAccessibleException
- Error accessing KMS key.OptionGroupNotFoundException
- The specified option group could not be found.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.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 the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of
the shared DB snapshot.
restoreDBInstanceFromDBSnapshot
in interface AmazonRDS
restoreDBInstanceFromDBSnapshotRequest
- DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DomainNotFoundException
- Domain does not refer to an existing Active Directory Domain.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.
restoreDBInstanceToPointInTime
in interface AmazonRDS
restoreDBInstanceToPointInTimeRequest
- DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.PointInTimeRestoreNotEnabledException
- SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DomainNotFoundException
- Domain does not refer to an existing Active Directory Domain.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).
revokeDBSecurityGroupIngress
in interface AmazonRDS
revokeDBSecurityGroupIngressRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.AmazonRDS client = new AmazonRDSClient(); RevokeDBSecurityGroupIngressRequest request = new RevokeDBSecurityGroupIngressRequest() .withCIDRIP("203.0.113.5/32").withDBSecurityGroupName( "mydbsecuritygroup"); DBSecurityGroup response = client.revokeDBSecurityGroupIngress(request);
public DBInstance startDBInstance(StartDBInstanceRequest request)
Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.
startDBInstance
in interface AmazonRDS
startDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDBClusterStateException
- The DB cluster is not in a valid state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.public DBInstance stopDBInstance(StopDBInstanceRequest request)
Stops a 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 and Starting a DB instance in the AWS RDS user guide.
stopDBInstance
in interface AmazonRDS
stopDBInstanceRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterStateException
- The DB cluster is not 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
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.