AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface RDSClient extends AutoCloseable
builder()
method.
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.
Modifier and Type | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AddRoleToDBClusterResponse |
addRoleToDBCluster(AddRoleToDBClusterRequest addRoleToDBClusterRequest) |
Associates an Identity and Access Management (IAM) role from an Aurora DB cluster.
|
default EventSubscription |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) |
Adds a source identifier to an existing RDS event notification subscription.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) |
Adds metadata tags to an Amazon RDS resource.
|
default ResourcePendingMaintenanceActions |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) |
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
default DBSecurityGroup |
authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) |
Enables ingress to a DBSecurityGroup using one of two forms of authorization.
|
static RDSClientBuilder |
builder() |
Create a builder that can be used to configure and create a
RDSClient . |
default DBClusterParameterGroup |
copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest) |
Copies the specified DB cluster parameter group.
|
default DBClusterSnapshot |
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) |
Copies a snapshot of a DB cluster.
|
default DBParameterGroup |
copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest) |
Copies the specified DB parameter group.
|
default DBSnapshot |
copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest) |
Copies the specified DB snapshot.
|
default OptionGroup |
copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest) |
Copies the specified option group.
|
static RDSClient |
create() |
Create a
RDSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default DBCluster |
createDBCluster(CreateDBClusterRequest createDBClusterRequest) |
Creates a new Amazon Aurora DB cluster.
|
default DBClusterParameterGroup |
createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) |
Creates a new DB cluster parameter group.
|
default DBClusterSnapshot |
createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) |
Creates a snapshot of a DB cluster.
|
default DBInstance |
createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) |
Creates a new DB instance.
|
default DBInstance |
createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) |
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a
source DB instance.
|
default DBParameterGroup |
createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest) |
Creates a new DB parameter group.
|
default DBSecurityGroup |
createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) |
Creates a new DB security group.
|
default DBSnapshot |
createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest) |
Creates a DBSnapshot.
|
default DBSubnetGroup |
createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) |
Creates a new DB subnet group.
|
default EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) |
Creates an RDS event notification subscription.
|
default OptionGroup |
createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest) |
Creates a new option group.
|
default DBCluster |
deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest) |
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
default DeleteDBClusterParameterGroupResponse |
deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) |
Deletes a specified DB cluster parameter group.
|
default DBClusterSnapshot |
deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) |
Deletes a DB cluster snapshot.
|
default DBInstance |
deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) |
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
default DeleteDBParameterGroupResponse |
deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) |
Deletes a specified DBParameterGroup.
|
default DeleteDBSecurityGroupResponse |
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) |
Deletes a DB security group.
|
default DBSnapshot |
deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest) |
Deletes a DBSnapshot.
|
default DeleteDBSubnetGroupResponse |
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) |
Deletes a DB subnet group.
|
default EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) |
Deletes an RDS event notification subscription.
|
default DeleteOptionGroupResponse |
deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest) |
Deletes an existing option group.
|
default DescribeAccountAttributesResponse |
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) |
Lists all of the attributes for a customer account.
|
default DescribeCertificatesResponse |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) |
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
|
default DescribeDBClusterParameterGroupsResponse |
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) |
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParametersResponse |
describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) |
Returns the detailed parameter list for a particular DB cluster parameter group.
|
default DescribeDBClustersResponse |
describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest) |
Returns information about provisioned Aurora DB clusters.
|
default DBClusterSnapshotAttributesResult |
describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest) |
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDBClusterSnapshotsResponse |
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) |
Returns information about DB cluster snapshots.
|
default DescribeDBEngineVersionsResponse |
describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) |
Returns a list of the available DB engines.
|
default DescribeDBInstancesResponse |
describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) |
Returns information about provisioned RDS instances.
|
default DescribeDBLogFilesResponse |
describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest) |
Returns a list of DB log files for the DB instance.
|
default DescribeDBParameterGroupsResponse |
describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) |
Returns a list of
DBParameterGroup descriptions. |
default DescribeDBParametersResponse |
describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest) |
Returns the detailed parameter list for a particular DB parameter group.
|
default DescribeDBSecurityGroupsResponse |
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) |
Returns a list of
DBSecurityGroup descriptions. |
default DBSnapshotAttributesResult |
describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest) |
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
|
default DescribeDBSnapshotsResponse |
describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) |
Returns information about DB snapshots.
|
default DescribeDBSubnetGroupsResponse |
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) |
Returns a list of DBSubnetGroup descriptions.
|
default EngineDefaults |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) |
Returns the default engine and system parameter information for the cluster database engine.
|
default EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) |
Returns the default engine and system parameter information for the specified database engine.
|
default DescribeEventCategoriesResponse |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) |
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest) |
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) |
Lists all the subscription descriptions for a customer account.
|
default DescribeOptionGroupOptionsResponse |
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) |
Describes all available options.
|
default DescribeOptionGroupsResponse |
describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) |
Describes the available option groups.
|
default DescribeOrderableDBInstanceOptionsResponse |
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) |
Returns a list of orderable DB instance options for the specified engine.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) |
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
default DescribeReservedDBInstancesResponse |
describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) |
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
|
default DescribeReservedDBInstancesOfferingsResponse |
describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) |
Lists available reserved DB instance offerings.
|
default DescribeSourceRegionsResponse |
describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest) |
Returns a list of the source AWS regions where the current AWS region can create a Read Replica or copy a DB
snapshot from.
|
default DownloadDBLogFilePortionResponse |
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) |
Downloads all or a portion of the specified log file, up to 1 MB in size.
|
default DBCluster |
failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest) |
Forces a failover for a DB cluster.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) |
Lists all tags on an Amazon RDS resource.
|
default DBCluster |
modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest) |
Modify a setting for an Amazon Aurora DB cluster.
|
default ModifyDBClusterParameterGroupResponse |
modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) |
Modifies the parameters of a DB cluster parameter group.
|
default DBClusterSnapshotAttributesResult |
modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest) |
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
default DBInstance |
modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest) |
Modifies settings for a DB instance.
|
default ModifyDBParameterGroupResponse |
modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) |
Modifies the parameters of a DB parameter group.
|
default DBSnapshot |
modifyDBSnapshot(ModifyDBSnapshotRequest modifyDBSnapshotRequest) |
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
|
default DBSnapshotAttributesResult |
modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest) |
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
|
default DBSubnetGroup |
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) |
Modifies an existing DB subnet group.
|
default EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) |
Modifies an existing RDS event notification subscription.
|
default OptionGroup |
modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest) |
Modifies an existing option group.
|
default DBInstance |
promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest) |
Promotes a Read Replica DB instance to a standalone DB instance.
|
default DBCluster |
promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest) |
Promotes a Read Replica DB cluster to a standalone DB cluster.
|
default ReservedDBInstance |
purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) |
Purchases a reserved DB instance offering.
|
default DBInstance |
rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) |
Rebooting a DB instance restarts the database engine service.
|
default RemoveRoleFromDBClusterResponse |
removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest) |
Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster.
|
default EventSubscription |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) |
Removes a source identifier from an existing RDS event notification subscription.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) |
Removes metadata tags from an Amazon RDS resource.
|
default ResetDBClusterParameterGroupResponse |
resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) |
Modifies the parameters of a DB cluster parameter group to the default value.
|
default ResetDBParameterGroupResponse |
resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) |
Modifies the parameters of a DB parameter group to the engine/system default value.
|
default DBCluster |
restoreDBClusterFromS3(RestoreDBClusterFromS3Request restoreDBClusterFromS3Request) |
Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket.
|
default DBCluster |
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) |
Creates a new DB cluster from a DB cluster snapshot.
|
default DBCluster |
restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) |
Restores a DB cluster to an arbitrary point in time.
|
default DBInstance |
restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) |
Creates a new DB instance from a DB snapshot.
|
default DBInstance |
restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) |
Restores a DB instance to an arbitrary point in time.
|
default DBSecurityGroup |
revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) |
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.
|
static ServiceMetadata |
serviceMetadata() |
|
default DBInstance |
startDBInstance(StartDBInstanceRequest startDBInstanceRequest) |
Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the
StopDBInstance action.
|
default DBInstance |
stopDBInstance(StopDBInstanceRequest stopDBInstanceRequest) |
Stops a DB instance.
|
RDSClientWaiters |
waiters() |
close
static final String SERVICE_NAME
static RDSClient create()
RDSClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static RDSClientBuilder builder()
RDSClient
.default AddRoleToDBClusterResponse addRoleToDBCluster(AddRoleToDBClusterRequest addRoleToDBClusterRequest) throws DBClusterNotFoundException, DBClusterRoleAlreadyExistsException, InvalidDBClusterStateException, DBClusterRoleQuotaExceededException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, SdkBaseException, SdkClientException, RDSException
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DBInstanceNotFoundException, DBSnapshotNotFoundException, DBClusterNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, RDSException
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionRequest
- ResourceNotFoundException
- The specified resource ID was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) throws DBSecurityGroupNotFoundException, InvalidDBSecurityGroupStateException, AuthorizationAlreadyExistsException, AuthorizationQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest) throws DBParameterGroupNotFoundException, DBParameterGroupQuotaExceededException, DBParameterGroupAlreadyExistsException, SdkBaseException, SdkClientException, RDSException
Copies the specified DB cluster parameter group.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) throws DBClusterSnapshotAlreadyExistsException, DBClusterSnapshotNotFoundException, InvalidDBClusterStateException, InvalidDBClusterSnapshotStateException, SnapshotQuotaExceededException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, RDSException
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 region where you call
the CopyDBClusterSnapshot
action is the destination region for the encrypted DB cluster snapshot to
be copied to. To copy an encrypted DB cluster snapshot from another 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 region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
action to be called in the source region where the DB cluster snapshot will be
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot
API action
that can be executed in the source 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 region. This is the same identifier for both the CopyDBClusterSnapshot
action
that is called in the destination region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the 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 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 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 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 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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest) throws DBParameterGroupNotFoundException, DBParameterGroupAlreadyExistsException, DBParameterGroupQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Copies the specified DB parameter group.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest) throws DBSnapshotAlreadyExistsException, DBSnapshotNotFoundException, InvalidDBSnapshotStateException, SnapshotQuotaExceededException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, RDSException
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 region where you call the
CopyDBSnapshot
action is the destination 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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupNotFoundException, OptionGroupQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Copies the specified option group.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster createDBCluster(CreateDBClusterRequest createDBClusterRequest) throws DBClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DBClusterQuotaExceededException, StorageQuotaExceededException, DBSubnetGroupNotFoundException, InvalidVPCNetworkStateException, InvalidDBClusterStateException, InvalidDBSubnetGroupStateException, InvalidSubnetException, InvalidDBInstanceStateException, DBClusterParameterGroupNotFoundException, KMSKeyNotAccessibleException, DBClusterNotFoundException, DBInstanceNotFoundException, DBSubnetGroupDoesNotCoverEnoughAZsException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) throws DBParameterGroupQuotaExceededException, DBParameterGroupAlreadyExistsException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) throws DBClusterSnapshotAlreadyExistsException, InvalidDBClusterStateException, DBClusterNotFoundException, SnapshotQuotaExceededException, InvalidDBClusterSnapshotStateException, SdkBaseException, SdkClientException, RDSException
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) throws DBInstanceAlreadyExistsException, InsufficientDBInstanceCapacityException, DBParameterGroupNotFoundException, DBSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DBSubnetGroupNotFoundException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidDBClusterStateException, InvalidSubnetException, InvalidVPCNetworkStateException, ProvisionedIopsNotAvailableInAZException, OptionGroupNotFoundException, DBClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KMSKeyNotAccessibleException, DomainNotFoundException, SdkBaseException, SdkClientException, RDSException
Creates a new DB instance.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) throws DBInstanceAlreadyExistsException, InsufficientDBInstanceCapacityException, DBParameterGroupNotFoundException, DBSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DBInstanceNotFoundException, InvalidDBInstanceStateException, DBSubnetGroupNotFoundException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, InvalidVPCNetworkStateException, ProvisionedIopsNotAvailableInAZException, OptionGroupNotFoundException, DBSubnetGroupNotAllowedException, InvalidDBSubnetGroupException, StorageTypeNotSupportedException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, RDSException
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.
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.
You can create an encrypted Read Replica in a different AWS Region than the source DB instance. In that case, the
region where you call the CreateDBInstanceReadReplica
action is the destination region of the
encrypted Read Replica. The source DB instance must be encrypted.
To create an encrypted Read Replica in 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 Read
Replica in the destination region.
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica
API action in the AWS region that contains the source DB instance. The
PreSignedUrl
parameter must be used when encrypting a Read Replica from another AWS region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API action that can be
executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the
following parameter values:
DestinationRegion
- The AWS Region that the Read Replica is created in. This region is the same one
where the CreateDBInstanceReadReplica
action is called that contains this presigned URL.
For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in
the west-2 region, then you call the CreateDBInstanceReadReplica
action in the us-east-1 region and
provide a presigned URL that contains a call to the CreateDBInstanceReadReplica
action in the
us-west-2 region. For this example, the DestinationRegion
in the presigned URL must be set to the
us-east-1 region.
KmsKeyId
- The KMS key identifier for the key to use to encrypt the Read Replica in the destination
region. This is the same identifier for both the CreateDBInstanceReadReplica
action that is called
in the destination region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted Read Replica to be
created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if
you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your
SourceDBInstanceIdentifier
would look like this example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-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.
DBInstanceIdentifier
- The identifier for the encrypted Read Replica in the destination region.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted Read Replica. This
identifier must be in the ARN format for the source region and is the same value as the
SourceDBInstanceIdentifier
in the presigned URL.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest) throws DBParameterGroupQuotaExceededException, DBParameterGroupAlreadyExistsException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) throws DBSecurityGroupAlreadyExistsException, DBSecurityGroupQuotaExceededException, DBSecurityGroupNotSupportedException, SdkBaseException, SdkClientException, RDSException
Creates a new DB security group. DB security groups control access to a DB instance.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest) throws DBSnapshotAlreadyExistsException, InvalidDBInstanceStateException, DBInstanceNotFoundException, SnapshotQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Creates a DBSnapshot. The source DBInstance must be in "available" state.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) throws DBSubnetGroupAlreadyExistsException, DBSubnetGroupQuotaExceededException, DBSubnetQuotaExceededException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, SdkBaseException, SdkClientException, RDSException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SNSInvalidTopicException, SNSNoAuthorizationException, SNSTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, SdkBaseException, SdkClientException, RDSException
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest) throws OptionGroupAlreadyExistsException, OptionGroupQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Creates a new option group. You can create up to 20 option groups.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest) throws DBClusterNotFoundException, InvalidDBClusterStateException, DBClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDBClusterSnapshotStateException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDBClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) throws InvalidDBParameterGroupStateException, DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) throws InvalidDBClusterSnapshotStateException, DBClusterSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
deleteDBClusterSnapshotRequest
- InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) throws DBInstanceNotFoundException, InvalidDBInstanceStateException, DBSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDBClusterStateException, SdkBaseException, SdkClientException, RDSException
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 the following 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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDBParameterGroupResponse deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) throws InvalidDBParameterGroupStateException, DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDBSecurityGroupResponse deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) throws InvalidDBSecurityGroupStateException, DBSecurityGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroupRequest
- InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest) throws InvalidDBSnapshotStateException, DBSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
deleteDBSnapshotRequest
- InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDBSubnetGroupResponse deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) throws InvalidDBSubnetGroupStateException, InvalidDBSubnetStateException, DBSubnetGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, SdkBaseException, SdkClientException, RDSException
Deletes an RDS event notification subscription.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteOptionGroupResponse deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest) throws OptionGroupNotFoundException, InvalidOptionGroupStateException, SdkBaseException, SdkClientException, RDSException
Deletes an existing option group.
deleteOptionGroupRequest
- OptionGroupNotFoundException
- The specified option group could not be found.InvalidOptionGroupStateException
- The option group is not in the available state.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws SdkBaseException, SdkClientException, RDSException
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.
describeAccountAttributesRequest
- SdkBaseException
SdkClientException
RDSException
default DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, SdkBaseException, SdkClientException, RDSException
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificatesRequest
- CertificateNotFoundException
- CertificateIdentifier does not refer to an existing certificate.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) throws DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBClusterParameterGroupsRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBClusterParametersResponse describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) throws DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBClusterParametersRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest) throws DBClusterSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBClusterSnapshotAttributesRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) throws DBClusterSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBClusterSnapshotsRequest
- DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBClustersResponse describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest) throws DBClusterNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBClustersRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBEngineVersionsResponse describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) throws SdkBaseException, SdkClientException, RDSException
Returns a list of the available DB engines.
describeDBEngineVersionsRequest
- SdkBaseException
SdkClientException
RDSException
default DescribeDBInstancesResponse describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) throws DBInstanceNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstancesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBLogFilesResponse describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest) throws DBInstanceNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns a list of DB log files for the DB instance.
describeDBLogFilesRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBParameterGroupsResponse describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) throws DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroupsRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBParametersResponse describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest) throws DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest
- DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBSecurityGroupsResponse describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) throws DBSecurityGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
the list will contain only the descriptions of the specified DB security group.
describeDBSecurityGroupsRequest
- DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest) throws DBSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBSnapshotAttributesRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBSnapshotsResponse describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) throws DBSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns information about DB snapshots. This API action supports pagination.
describeDBSnapshotsRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDBSubnetGroupsResponse describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) throws DBSubnetGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeDBSubnetGroupsRequest
- DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws SdkBaseException, SdkClientException, RDSException
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.
describeEngineDefaultClusterParametersRequest
- SdkBaseException
SdkClientException
RDSException
default EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws SdkBaseException, SdkClientException, RDSException
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- SdkBaseException
SdkClientException
RDSException
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws SdkBaseException, SdkClientException, RDSException
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.
describeEventCategoriesRequest
- SdkBaseException
SdkClientException
RDSException
default DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws SdkBaseException, SdkClientException, RDSException
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.
describeEventsRequest
- SdkBaseException
SdkClientException
RDSException
default DescribeOptionGroupOptionsResponse describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws SdkBaseException, SdkClientException, RDSException
Describes all available options.
describeOptionGroupOptionsRequest
- SdkBaseException
SdkClientException
RDSException
default DescribeOptionGroupsResponse describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws OptionGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Describes the available option groups.
describeOptionGroupsRequest
- OptionGroupNotFoundException
- The specified option group could not be found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeOrderableDBInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) throws SdkBaseException, SdkClientException, RDSException
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest
- SdkBaseException
SdkClientException
RDSException
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest
- ResourceNotFoundException
- The specified resource ID was not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReservedDBInstancesResponse describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) throws ReservedDBInstanceNotFoundException, SdkBaseException, SdkClientException, RDSException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesRequest
- ReservedDBInstanceNotFoundException
- The specified reserved DB Instance not found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReservedDBInstancesOfferingsResponse describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) throws ReservedDBInstancesOfferingNotFoundException, SdkBaseException, SdkClientException, RDSException
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferingsRequest
- ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeSourceRegionsResponse describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest) throws SdkBaseException, SdkClientException, RDSException
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.
describeSourceRegionsRequest
- SdkBaseException
SdkClientException
RDSException
default DownloadDBLogFilePortionResponse downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) throws DBInstanceNotFoundException, DBLogFileNotFoundException, SdkBaseException, SdkClientException, RDSException
Downloads all or a portion of the specified log file, up to 1 MB in size.
downloadDBLogFilePortionRequest
- DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBLogFileNotFoundException
- LogFileName does not refer to an existing DB log file.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest) throws DBClusterNotFoundException, InvalidDBClusterStateException, InvalidDBInstanceStateException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DBInstanceNotFoundException, DBSnapshotNotFoundException, DBClusterNotFoundException, SdkBaseException, SdkClientException, RDSException
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest) throws DBClusterNotFoundException, InvalidDBClusterStateException, StorageQuotaExceededException, DBSubnetGroupNotFoundException, InvalidVPCNetworkStateException, InvalidDBSubnetGroupStateException, InvalidSubnetException, DBClusterParameterGroupNotFoundException, InvalidDBSecurityGroupStateException, InvalidDBInstanceStateException, DBClusterAlreadyExistsException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyDBClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) throws DBParameterGroupNotFoundException, InvalidDBParameterGroupStateException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest) throws DBClusterSnapshotNotFoundException, InvalidDBClusterSnapshotStateException, SharedSnapshotQuotaExceededException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest) throws InvalidDBInstanceStateException, InvalidDBSecurityGroupStateException, DBInstanceAlreadyExistsException, DBInstanceNotFoundException, DBSecurityGroupNotFoundException, DBParameterGroupNotFoundException, InsufficientDBInstanceCapacityException, StorageQuotaExceededException, InvalidVPCNetworkStateException, ProvisionedIopsNotAvailableInAZException, OptionGroupNotFoundException, DBUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyDBParameterGroupResponse modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) throws DBParameterGroupNotFoundException, InvalidDBParameterGroupStateException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSnapshot modifyDBSnapshot(ModifyDBSnapshotRequest modifyDBSnapshotRequest) throws DBSnapshotNotFoundException, SdkBaseException, SdkClientException, RDSException
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. You can update the engine version to either a new major or minor engine version.
Amazon RDS supports upgrading a MySQL DB snapshot from MySQL 5.1 to MySQL 5.5.
modifyDBSnapshotRequest
- DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest) throws DBSnapshotNotFoundException, InvalidDBSnapshotStateException, SharedSnapshotQuotaExceededException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) throws DBSubnetGroupNotFoundException, DBSubnetQuotaExceededException, SubnetAlreadyInUseException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, SdkBaseException, SdkClientException, RDSException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SNSInvalidTopicException, SNSNoAuthorizationException, SNSTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest) throws InvalidOptionGroupStateException, OptionGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
Modifies an existing option group.
modifyOptionGroupRequest
- InvalidOptionGroupStateException
- The option group is not in the available state.OptionGroupNotFoundException
- The specified option group could not be found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest) throws InvalidDBInstanceStateException, DBInstanceNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
promoteReadReplicaRequest
- InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest) throws DBClusterNotFoundException, InvalidDBClusterStateException, SdkBaseException, SdkClientException, RDSException
Promotes a Read Replica DB cluster to a standalone DB cluster.
promoteReadReplicaDBClusterRequest
- DBClusterNotFoundException
- DBClusterIdentifier does not refer to an existing DB cluster.InvalidDBClusterStateException
- The DB cluster is not in a valid state.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) throws ReservedDBInstancesOfferingNotFoundException, ReservedDBInstanceAlreadyExistsException, ReservedDBInstanceQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Purchases a reserved DB instance offering.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) throws InvalidDBInstanceStateException, DBInstanceNotFoundException, SdkBaseException, SdkClientException, RDSException
Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
rebootDBInstanceRequest
- InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveRoleFromDBClusterResponse removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest) throws DBClusterNotFoundException, DBClusterRoleNotFoundException, InvalidDBClusterStateException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, SdkBaseException, SdkClientException, RDSException
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
- SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DBInstanceNotFoundException, DBSnapshotNotFoundException, DBClusterNotFoundException, SdkBaseException, SdkClientException, RDSException
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ResetDBClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) throws InvalidDBParameterGroupStateException, DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ResetDBParameterGroupResponse resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) throws InvalidDBParameterGroupStateException, DBParameterGroupNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster restoreDBClusterFromS3(RestoreDBClusterFromS3Request restoreDBClusterFromS3Request) throws DBClusterAlreadyExistsException, DBClusterQuotaExceededException, StorageQuotaExceededException, DBSubnetGroupNotFoundException, InvalidVPCNetworkStateException, InvalidDBClusterStateException, InvalidDBSubnetGroupStateException, InvalidSubnetException, InvalidS3BucketException, DBClusterParameterGroupNotFoundException, KMSKeyNotAccessibleException, DBClusterNotFoundException, InsufficientStorageClusterCapacityException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) throws DBClusterAlreadyExistsException, DBClusterQuotaExceededException, StorageQuotaExceededException, DBSubnetGroupNotFoundException, DBSnapshotNotFoundException, DBClusterSnapshotNotFoundException, InsufficientDBClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDBSnapshotStateException, InvalidDBClusterSnapshotStateException, InvalidVPCNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, RDSException
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) throws DBClusterAlreadyExistsException, DBClusterNotFoundException, DBClusterQuotaExceededException, DBClusterSnapshotNotFoundException, DBSubnetGroupNotFoundException, InsufficientDBClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDBClusterSnapshotStateException, InvalidDBClusterStateException, InvalidDBSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVPCNetworkStateException, KMSKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, SdkBaseException, SdkClientException, RDSException
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up to BackupRetentionPeriod
days. The target DB cluster is
created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB
cluster is created with the default DB security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) throws DBInstanceAlreadyExistsException, DBSnapshotNotFoundException, InstanceQuotaExceededException, InsufficientDBInstanceCapacityException, InvalidDBSnapshotStateException, StorageQuotaExceededException, InvalidVPCNetworkStateException, InvalidRestoreException, DBSubnetGroupNotFoundException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAZException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KMSKeyNotAccessibleException, DBSecurityGroupNotFoundException, DomainNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) throws DBInstanceAlreadyExistsException, DBInstanceNotFoundException, InstanceQuotaExceededException, InsufficientDBInstanceCapacityException, InvalidDBInstanceStateException, PointInTimeRestoreNotEnabledException, StorageQuotaExceededException, InvalidVPCNetworkStateException, InvalidRestoreException, DBSubnetGroupNotFoundException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, ProvisionedIopsNotAvailableInAZException, OptionGroupNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KMSKeyNotAccessibleException, DBSecurityGroupNotFoundException, DomainNotFoundException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) throws DBSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidDBSecurityGroupStateException, SdkBaseException, SdkClientException, RDSException
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).
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance startDBInstance(StartDBInstanceRequest startDBInstanceRequest) throws DBInstanceNotFoundException, InvalidDBInstanceStateException, InsufficientDBInstanceCapacityException, DBSubnetGroupNotFoundException, DBSubnetGroupDoesNotCoverEnoughAZsException, InvalidDBClusterStateException, InvalidSubnetException, InvalidVPCNetworkStateException, DBClusterNotFoundException, AuthorizationNotFoundException, KMSKeyNotAccessibleException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DBInstance stopDBInstance(StopDBInstanceRequest stopDBInstanceRequest) throws DBInstanceNotFoundException, InvalidDBInstanceStateException, DBSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDBClusterStateException, SdkBaseException, SdkClientException, RDSException
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.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)RDSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
RDSClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.