Interface AmazonRDS
- All Known Subinterfaces:
AmazonRDSAsync
- All Known Implementing Classes:
AbstractAmazonRDS
,AbstractAmazonRDSAsync
,AmazonRDSAsyncClient
,AmazonRDSClient
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
-
For the alphabetical list of API actions, see API Actions.
-
For the alphabetical list of data types, see Data Types.
-
For a list of common query parameters, see Common Parameters.
-
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
-
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
-
For more information about how to use the Query API, see Using the Query API.
-
Method Summary
Modifier and TypeMethodDescriptionaddSourceIdentifierToSubscription
(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon RDS resource.applyPendingMaintenanceAction
(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).authorizeDBSecurityGroupIngress
(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization.copyDBClusterSnapshot
(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) Creates a snapshot of a DB cluster.copyDBParameterGroup
(CopyDBParameterGroupRequest copyDBParameterGroupRequest) Copies the specified DB parameter group.copyDBSnapshot
(CopyDBSnapshotRequest copyDBSnapshotRequest) Copies the specified DB snapshot.copyOptionGroup
(CopyOptionGroupRequest copyOptionGroupRequest) Copies the specified option group.createDBCluster
(CreateDBClusterRequest createDBClusterRequest) Creates a new Amazon Aurora DB cluster.createDBClusterParameterGroup
(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) Creates a new DB cluster parameter group.createDBClusterSnapshot
(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) Creates a snapshot of a DB cluster.createDBInstance
(CreateDBInstanceRequest createDBInstanceRequest) Creates a new DB instance.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.createDBParameterGroup
(CreateDBParameterGroupRequest createDBParameterGroupRequest) Creates a new DB parameter group.createDBSecurityGroup
(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) Creates a new DB security group.createDBSnapshot
(CreateDBSnapshotRequest createDBSnapshotRequest) Creates a DBSnapshot.createDBSubnetGroup
(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) Creates a new DB subnet group.createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an RDS event notification subscription.createOptionGroup
(CreateOptionGroupRequest createOptionGroupRequest) Creates a new option group.deleteDBCluster
(DeleteDBClusterRequest deleteDBClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.deleteDBClusterParameterGroup
(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.deleteDBClusterSnapshot
(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) Deletes a DB cluster snapshot.deleteDBInstance
(DeleteDBInstanceRequest deleteDBInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance.deleteDBParameterGroup
(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) Deletes a specified DBParameterGroup.deleteDBSecurityGroup
(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) Deletes a DB security group.deleteDBSnapshot
(DeleteDBSnapshotRequest deleteDBSnapshotRequest) Deletes a DBSnapshot.deleteDBSubnetGroup
(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a DB subnet group.deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.deleteOptionGroup
(DeleteOptionGroupRequest deleteOptionGroupRequest) Deletes an existing option group.Simplified method form for invoking the DescribeAccountAttributes operation.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Lists all of the attributes for a customer account.Simplified method form for invoking the DescribeCertificates operation.describeCertificates
(DescribeCertificatesRequest describeCertificatesRequest) Lists the set of CA certificates provided by Amazon RDS for this AWS account.Simplified method form for invoking the DescribeDBClusterParameterGroups operation.describeDBClusterParameterGroups
(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameters
(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.Simplified method form for invoking the DescribeDBClusters operation.describeDBClusters
(DescribeDBClustersRequest describeDBClustersRequest) Returns information about provisioned Aurora DB clusters.Simplified method form for invoking the DescribeDBClusterSnapshots operation.describeDBClusterSnapshots
(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) Returns information about DB cluster snapshots.Simplified method form for invoking the DescribeDBEngineVersions operation.describeDBEngineVersions
(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available DB engines.Simplified method form for invoking the DescribeDBInstances operation.describeDBInstances
(DescribeDBInstancesRequest describeDBInstancesRequest) Returns information about provisioned RDS instances.describeDBLogFiles
(DescribeDBLogFilesRequest describeDBLogFilesRequest) Returns a list of DB log files for the DB instance.Simplified method form for invoking the DescribeDBParameterGroups operation.describeDBParameterGroups
(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.describeDBParameters
(DescribeDBParametersRequest describeDBParametersRequest) Returns the detailed parameter list for a particular DB parameter group.Simplified method form for invoking the DescribeDBSecurityGroups operation.describeDBSecurityGroups
(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) Returns a list ofDBSecurityGroup
descriptions.Simplified method form for invoking the DescribeDBSnapshotAttributes operation.describeDBSnapshotAttributes
(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest) Returns a list of DB snapshot attribute names and values for a manual DB snapshot.Simplified method form for invoking the DescribeDBSnapshots operation.describeDBSnapshots
(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) Returns information about DB snapshots.Simplified method form for invoking the DescribeDBSubnetGroups operation.describeDBSubnetGroups
(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.describeEngineDefaultClusterParameters
(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultParameters
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.Simplified method form for invoking the DescribeEventCategories operation.describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.Simplified method form for invoking the DescribeEvents operation.describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.Simplified method form for invoking the DescribeEventSubscriptions operation.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.describeOptionGroupOptions
(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) Describes all available options.Simplified method form for invoking the DescribeOptionGroups operation.describeOptionGroups
(DescribeOptionGroupsRequest describeOptionGroupsRequest) Describes the available option groups.describeOrderableDBInstanceOptions
(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.Simplified method form for invoking the DescribePendingMaintenanceActions operation.describePendingMaintenanceActions
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.Simplified method form for invoking the DescribeReservedDBInstances operation.describeReservedDBInstances
(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.describeReservedDBInstancesOfferings
(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) Lists available reserved DB instance offerings.downloadDBLogFilePortion
(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.Simplified method form for invoking the FailoverDBCluster operation.failoverDBCluster
(FailoverDBClusterRequest failoverDBClusterRequest) Forces a failover for a DB cluster.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.modifyDBCluster
(ModifyDBClusterRequest modifyDBClusterRequest) Modify a setting for an Amazon Aurora DB cluster.modifyDBClusterParameterGroup
(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBInstance
(ModifyDBInstanceRequest modifyDBInstanceRequest) Modify settings for a DB instance.modifyDBParameterGroup
(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) Modifies the parameters of a DB parameter group.modifyDBSnapshotAttribute
(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.modifyDBSubnetGroup
(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) Modifies an existing DB subnet group.modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription.modifyOptionGroup
(ModifyOptionGroupRequest modifyOptionGroupRequest) Modifies an existing option group.promoteReadReplica
(PromoteReadReplicaRequest promoteReadReplicaRequest) Promotes a Read Replica DB instance to a standalone DB instance.purchaseReservedDBInstancesOffering
(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) Purchases a reserved DB instance offering.rebootDBInstance
(RebootDBInstanceRequest rebootDBInstanceRequest) Rebooting a DB instance restarts the database engine service.removeSourceIdentifierFromSubscription
(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.resetDBClusterParameterGroup
(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.resetDBParameterGroup
(ResetDBParameterGroupRequest resetDBParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.restoreDBClusterFromSnapshot
(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) Creates a new DB cluster from a DB cluster snapshot.restoreDBClusterToPointInTime
(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.restoreDBInstanceFromDBSnapshot
(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) Creates a new DB instance from a DB snapshot.restoreDBInstanceToPointInTime
(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) Restores a DB instance to an arbitrary point in time.revokeDBSecurityGroupIngress
(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("rds.amazonaws.com").void
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.
-
Method Details
-
setEndpoint
Overrides the default endpoint for this client ("rds.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "rds.amazonaws.com") or a full URL, including the protocol (ex: "rds.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
endpoint
- The endpoint (ex: "rds.amazonaws.com") or a full URL, including the protocol (ex: "rds.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
addSourceIdentifierToSubscription
EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest
-- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.
-
addTagsToResource
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.
- Parameters:
addTagsToResourceRequest
-- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
applyPendingMaintenanceAction
ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).
- Parameters:
applyPendingMaintenanceActionRequest
-- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource ID was not found.
-
authorizeDBSecurityGroupIngress
DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Parameters:
authorizeDBSecurityGroupIngressRequest
-- Returns:
- Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
- Throws:
DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.AuthorizationAlreadyExistsException
- The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.AuthorizationQuotaExceededException
- DB security group authorization quota has been reached.
-
copyDBClusterSnapshot
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
copyDBClusterSnapshotRequest
-- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- Throws:
DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.
-
copyDBParameterGroup
Copies the specified DB parameter group.
- Parameters:
copyDBParameterGroupRequest
-- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.
-
copyDBSnapshot
Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.
If you are copying from a shared manual DB snapshot, the
SourceDBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Parameters:
copyDBSnapshotRequest
-- Returns:
- Result of the CopyDBSnapshot operation returned by the service.
- Throws:
DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
copyOptionGroup
Copies the specified option group.
- Parameters:
copyOptionGroupRequest
-- Returns:
- Result of the CopyOptionGroup operation returned by the service.
- Throws:
OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupNotFoundException
- The specified option group could not be found.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this AWS account.
-
createDBCluster
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
createDBClusterRequest
-- Returns:
- Result of the CreateDBCluster operation returned by the service.
- Throws:
DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.KMSKeyNotAccessibleException
- Error accessing KMS key.DBClusterNotFoundException
- DBClusterIdentifier
-
createDBClusterParameterGroup
DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
createDBClusterParameterGroupRequest
-- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- Throws:
DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.
-
createDBClusterSnapshot
DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
createDBClusterSnapshotRequest
-- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- Throws:
DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.DBClusterNotFoundException
- DBClusterIdentifierSnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.
-
createDBInstance
Creates a new DB instance.
- Parameters:
createDBInstanceRequest
-- Returns:
- Result of the CreateDBInstance operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBClusterNotFoundException
- DBClusterIdentifierStorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DomainNotFoundException
-
createDBInstanceReadReplica
DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
- Parameters:
createDBInstanceReadReplicaRequest
-- Returns:
- Result of the CreateDBInstanceReadReplica operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBSubnetGroupNotAllowedException
- Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.InvalidDBSubnetGroupException
- Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
createDBParameterGroup
DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest) Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
createDBParameterGroupRequest
-- Returns:
- Result of the CreateDBParameterGroup operation returned by the service.
- Throws:
DBParameterGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB parameter groups.DBParameterGroupAlreadyExistsException
- A DB parameter group with the same name exists.
-
createDBSecurityGroup
Creates a new DB security group. DB security groups control access to a DB instance.
- Parameters:
createDBSecurityGroupRequest
-- Returns:
- Result of the CreateDBSecurityGroup operation returned by the service.
- Throws:
DBSecurityGroupAlreadyExistsException
- A DB security group with the name specified in DBSecurityGroupName already exists.DBSecurityGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB security groups.DBSecurityGroupNotSupportedException
- A DB security group is not allowed for this action.
-
createDBSnapshot
Creates a DBSnapshot. The source DBInstance must be in "available" state.
- Parameters:
createDBSnapshotRequest
-- Returns:
- Result of the CreateDBSnapshot operation returned by the service.
- Throws:
DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.
-
createDBSubnetGroup
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
- Parameters:
createDBSubnetGroupRequest
-- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- Throws:
DBSubnetGroupAlreadyExistsException
- DBSubnetGroupName is already used by an existing DB subnet group.DBSubnetGroupQuotaExceededException
- Request would result in user exceeding the allowed number of DB subnet groups.DBSubnetQuotaExceededException
- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
createEventSubscription
EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
- Parameters:
createEventSubscriptionRequest
-- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException
- The supplied subscription name already exists.SNSInvalidTopicException
- SNS has responded that there is a problem with the SND topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.SourceNotFoundException
- The requested source could not be found.
-
createOptionGroup
Creates a new option group. You can create up to 20 option groups.
- Parameters:
createOptionGroupRequest
-- Returns:
- Result of the CreateOptionGroup operation returned by the service.
- Throws:
OptionGroupAlreadyExistsException
- The option group you are trying to create already exists.OptionGroupQuotaExceededException
- The quota of 20 option groups was exceeded for this AWS account.
-
deleteDBCluster
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
deleteDBClusterRequest
-- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.DBClusterSnapshotAlreadyExistsException
- User already has a DB cluster snapshot with the given identifier.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.
-
deleteDBClusterParameterGroup
DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
deleteDBClusterParameterGroupRequest
-- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
deleteDBClusterSnapshot
DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be deleted.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
deleteDBClusterSnapshotRequest
-- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- Throws:
InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
-
deleteDBInstance
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
- Parameters:
deleteDBInstanceRequest
-- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBSnapshotAlreadyExistsException
- DBSnapshotIdentifier is already used by an existing snapshot.SnapshotQuotaExceededException
- Request would result in user exceeding the allowed number of DB snapshots.InvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.
-
deleteDBParameterGroup
DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
- Parameters:
deleteDBParameterGroupRequest
-- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
deleteDBSecurityGroup
DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) Deletes a DB security group.
The specified DB security group must not be associated with any DB instances. - Parameters:
deleteDBSecurityGroupRequest
-- Returns:
- Result of the DeleteDBSecurityGroup operation returned by the service.
- Throws:
InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.
-
deleteDBSnapshot
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.- Parameters:
deleteDBSnapshotRequest
-- Returns:
- Result of the DeleteDBSnapshot operation returned by the service.
- Throws:
InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
deleteDBSubnetGroup
DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances. - Parameters:
deleteDBSubnetGroupRequest
-- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- Throws:
InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidDBSubnetStateException
- The DB subnet is not in the available state.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.
-
deleteEventSubscription
EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an RDS event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.InvalidEventSubscriptionStateException
- This error can occur if someone else is modifying a subscription. You should retry the action.
-
deleteOptionGroup
Deletes an existing option group.
- Parameters:
deleteOptionGroupRequest
-- Returns:
- Result of the DeleteOptionGroup operation returned by the service.
- Throws:
OptionGroupNotFoundException
- The specified option group could not be found.InvalidOptionGroupStateException
- The option group is not in the available state.
-
describeAccountAttributes
DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
- Parameters:
describeAccountAttributesRequest
-- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
-
describeAccountAttributes
DescribeAccountAttributesResult describeAccountAttributes()Simplified method form for invoking the DescribeAccountAttributes operation.- See Also:
-
describeCertificates
DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) Lists the set of CA certificates provided by Amazon RDS for this AWS account.
- Parameters:
describeCertificatesRequest
-- Returns:
- Result of the DescribeCertificates operation returned by the service.
- Throws:
CertificateNotFoundException
- CertificateIdentifier
-
describeCertificates
DescribeCertificatesResult describeCertificates()Simplified method form for invoking the DescribeCertificates operation.- See Also:
-
describeDBClusterParameterGroups
DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
describeDBClusterParameterGroupsRequest
-- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBClusterParameterGroups
DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups()Simplified method form for invoking the DescribeDBClusterParameterGroups operation.- See Also:
-
describeDBClusterParameters
DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
describeDBClusterParametersRequest
-- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBClusterSnapshots
DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
describeDBClusterSnapshotsRequest
-- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifier
-
describeDBClusterSnapshots
DescribeDBClusterSnapshotsResult describeDBClusterSnapshots()Simplified method form for invoking the DescribeDBClusterSnapshots operation.- See Also:
-
describeDBClusters
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.
- Parameters:
describeDBClustersRequest
-- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifier
-
describeDBClusters
DescribeDBClustersResult describeDBClusters()Simplified method form for invoking the DescribeDBClusters operation.- See Also:
-
describeDBEngineVersions
DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available DB engines.
- Parameters:
describeDBEngineVersionsRequest
-- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
-
describeDBEngineVersions
DescribeDBEngineVersionsResult describeDBEngineVersions()Simplified method form for invoking the DescribeDBEngineVersions operation.- See Also:
-
describeDBInstances
DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) Returns information about provisioned RDS instances. This API supports pagination.
- Parameters:
describeDBInstancesRequest
-- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
describeDBInstances
DescribeDBInstancesResult describeDBInstances()Simplified method form for invoking the DescribeDBInstances operation.- See Also:
-
describeDBLogFiles
Returns a list of DB log files for the DB instance.
- Parameters:
describeDBLogFilesRequest
-- Returns:
- Result of the DescribeDBLogFiles operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
describeDBParameterGroups
DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Parameters:
describeDBParameterGroupsRequest
-- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBParameterGroups
DescribeDBParameterGroupsResult describeDBParameterGroups()Simplified method form for invoking the DescribeDBParameterGroups operation.- See Also:
-
describeDBParameters
DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest) Returns the detailed parameter list for a particular DB parameter group.
- Parameters:
describeDBParametersRequest
-- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
describeDBSecurityGroups
DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) Returns a list of
DBSecurityGroup
descriptions. If aDBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security group.- Parameters:
describeDBSecurityGroupsRequest
-- Returns:
- Result of the DescribeDBSecurityGroups operation returned by the service.
- Throws:
DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.
-
describeDBSecurityGroups
DescribeDBSecurityGroupsResult describeDBSecurityGroups()Simplified method form for invoking the DescribeDBSecurityGroups operation.- See Also:
-
describeDBSnapshotAttributes
DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest) Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts,
DescribeDBSnapshotAttributes
returns therestore
attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API.
- Parameters:
describeDBSnapshotAttributesRequest
-- Returns:
- Result of the DescribeDBSnapshotAttributes operation returned by the service.
- Throws:
DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
describeDBSnapshotAttributes
DBSnapshotAttributesResult describeDBSnapshotAttributes()Simplified method form for invoking the DescribeDBSnapshotAttributes operation.- See Also:
-
describeDBSnapshots
DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) Returns information about DB snapshots. This API supports pagination.
- Parameters:
describeDBSnapshotsRequest
-- Returns:
- Result of the DescribeDBSnapshots operation returned by the service.
- Throws:
DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
describeDBSnapshots
DescribeDBSnapshotsResult describeDBSnapshots()Simplified method form for invoking the DescribeDBSnapshots operation.- See Also:
-
describeDBSubnetGroups
DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
- Parameters:
describeDBSubnetGroupsRequest
-- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.
-
describeDBSubnetGroups
DescribeDBSubnetGroupsResult describeDBSubnetGroups()Simplified method form for invoking the DescribeDBSubnetGroups operation.- See Also:
-
describeEngineDefaultClusterParameters
EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
describeEngineDefaultClusterParametersRequest
-- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
-
describeEngineDefaultParameters
EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
-
describeEventCategories
DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
- Parameters:
describeEventCategoriesRequest
-- Returns:
- Result of the DescribeEventCategories operation returned by the service.
-
describeEventCategories
DescribeEventCategoriesResult describeEventCategories()Simplified method form for invoking the DescribeEventCategories operation.- See Also:
-
describeEventSubscriptions
DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.
-
describeEventSubscriptions
DescribeEventSubscriptionsResult describeEventSubscriptions()Simplified method form for invoking the DescribeEventSubscriptions operation.- See Also:
-
describeEvents
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.
- Parameters:
describeEventsRequest
-- Returns:
- Result of the DescribeEvents operation returned by the service.
-
describeEvents
DescribeEventsResult describeEvents()Simplified method form for invoking the DescribeEvents operation.- See Also:
-
describeOptionGroupOptions
DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) Describes all available options.
- Parameters:
describeOptionGroupOptionsRequest
-- Returns:
- Result of the DescribeOptionGroupOptions operation returned by the service.
-
describeOptionGroups
DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest) Describes the available option groups.
- Parameters:
describeOptionGroupsRequest
-- Returns:
- Result of the DescribeOptionGroups operation returned by the service.
- Throws:
OptionGroupNotFoundException
- The specified option group could not be found.
-
describeOptionGroups
DescribeOptionGroupsResult describeOptionGroups()Simplified method form for invoking the DescribeOptionGroups operation.- See Also:
-
describeOrderableDBInstanceOptions
DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.
- Parameters:
describeOrderableDBInstanceOptionsRequest
-- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
-
describePendingMaintenanceActions
DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource ID was not found.
-
describePendingMaintenanceActions
DescribePendingMaintenanceActionsResult describePendingMaintenanceActions()Simplified method form for invoking the DescribePendingMaintenanceActions operation.- See Also:
-
describeReservedDBInstances
DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
- Parameters:
describeReservedDBInstancesRequest
-- Returns:
- Result of the DescribeReservedDBInstances operation returned by the service.
- Throws:
ReservedDBInstanceNotFoundException
- The specified reserved DB Instance not found.
-
describeReservedDBInstances
DescribeReservedDBInstancesResult describeReservedDBInstances()Simplified method form for invoking the DescribeReservedDBInstances operation.- See Also:
-
describeReservedDBInstancesOfferings
DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) Lists available reserved DB instance offerings.
- Parameters:
describeReservedDBInstancesOfferingsRequest
-- Returns:
- Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
- Throws:
ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.
-
describeReservedDBInstancesOfferings
DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.- See Also:
-
downloadDBLogFilePortion
DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) Downloads all or a portion of the specified log file, up to 1 MB in size.
- Parameters:
downloadDBLogFilePortionRequest
-- Returns:
- Result of the DownloadDBLogFilePortion operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBLogFileNotFoundException
- LogFileName
-
failoverDBCluster
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
failoverDBClusterRequest
-- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.
-
failoverDBCluster
DBCluster failoverDBCluster()Simplified method form for invoking the FailoverDBCluster operation.- See Also:
-
listTagsForResource
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
modifyDBCluster
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.
- Parameters:
modifyDBClusterRequest
-- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- Throws:
DBClusterNotFoundException
- DBClusterIdentifierInvalidDBClusterStateException
- The supplied value is not a valid DB cluster state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidDBSubnetGroupStateException
- The DB subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.DBClusterParameterGroupNotFoundException
- DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.
-
modifyDBClusterParameterGroup
ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.- Parameters:
modifyDBClusterParameterGroupRequest
-- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.
-
modifyDBInstance
Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
- Parameters:
modifyDBInstanceRequest
-- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- Throws:
InvalidDBInstanceStateException
- The specified DB instance is not in the available state.InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.DBUpgradeDependencyFailureException
- The DB upgrade failed because a resource the DB depends on could not be modified.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
CertificateNotFoundException
- CertificateIdentifierDomainNotFoundException
-
modifyDBParameterGroup
ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the
character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.- Parameters:
modifyDBParameterGroupRequest
-- Returns:
- Result of the ModifyDBParameterGroup operation returned by the service.
- Throws:
DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.
-
modifyDBSnapshotAttribute
DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify
restore
as theAttributeName
and use theValuesToAdd
parameter to add a list of the AWS account ids that are authorized to restore the manual DB snapshot. Uses the valueall
to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add theall
value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.
If the manual DB snapshot is encrypted, it cannot be shared.
- Parameters:
modifyDBSnapshotAttributeRequest
-- Returns:
- Result of the ModifyDBSnapshotAttribute operation returned by the service.
- Throws:
DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.SharedSnapshotQuotaExceededException
- You have exceeded the maximum number of account ids that you can share a manual DB snapshot with.
-
modifyDBSubnetGroup
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
- Parameters:
modifyDBSubnetGroupRequest
-- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- Throws:
DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetQuotaExceededException
- Request would result in user exceeding the allowed number of subnets in a DB subnet groups.SubnetAlreadyInUseException
- The DB subnet is already in use in the Availability Zone.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
modifyEventSubscription
EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException
- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException
- The subscription name does not exist.SNSInvalidTopicException
- SNS has responded that there is a problem with the SND topic specified.SNSNoAuthorizationException
- You do not have permission to publish to the SNS topic ARN.SNSTopicArnNotFoundException
- The SNS topic ARN does not exist.SubscriptionCategoryNotFoundException
- The supplied category does not exist.
-
modifyOptionGroup
Modifies an existing option group.
- Parameters:
modifyOptionGroupRequest
-- Returns:
- Result of the ModifyOptionGroup operation returned by the service.
- Throws:
InvalidOptionGroupStateException
- The option group is not in the available state.OptionGroupNotFoundException
- The specified option group could not be found.
-
promoteReadReplica
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.
- Parameters:
promoteReadReplicaRequest
-- Returns:
- Result of the PromoteReadReplica operation returned by the service.
- Throws:
InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
purchaseReservedDBInstancesOffering
ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) Purchases a reserved DB instance offering.
- Parameters:
purchaseReservedDBInstancesOfferingRequest
-- Returns:
- Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
- Throws:
ReservedDBInstancesOfferingNotFoundException
- Specified offering does not exist.ReservedDBInstanceAlreadyExistsException
- User already has a reservation with the given identifier.ReservedDBInstanceQuotaExceededException
- Request would exceed the user's DB Instance quota.
-
rebootDBInstance
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.
- Parameters:
rebootDBInstanceRequest
-- Returns:
- Result of the RebootDBInstance operation returned by the service.
- Throws:
InvalidDBInstanceStateException
- The specified DB instance is not in the available state.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.
-
removeSourceIdentifierFromSubscription
EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
-- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException
- The subscription name does not exist.SourceNotFoundException
- The requested source could not be found.
-
removeTagsFromResource
RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.
-
resetDBClusterParameterGroup
ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
parameters.When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
resetDBClusterParameterGroupRequest
-- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
resetDBParameterGroup
ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Parameters:
resetDBParameterGroupRequest
-- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- Throws:
InvalidDBParameterGroupStateException
- The DB parameter group cannot be deleted because it is in use.DBParameterGroupNotFoundException
- DBParameterGroupName does not refer to an existing DB parameter group.
-
restoreDBClusterFromSnapshot
DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
restoreDBClusterFromSnapshotRequest
-- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- Throws:
DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.DBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifierInsufficientDBClusterCapacityException
- The DB cluster does not have enough capacity for the current operation.InsufficientStorageClusterCapacityException
- There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
restoreDBClusterToPointInTime
DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- Parameters:
restoreDBClusterToPointInTimeRequest
-- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- Throws:
DBClusterAlreadyExistsException
- User already has a DB cluster with the given identifier.DBClusterQuotaExceededException
- User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBClusterNotFoundException
- DBClusterIdentifierDBClusterSnapshotNotFoundException
- DBClusterSnapshotIdentifierInsufficientDBClusterCapacityException
- The DB cluster does not have enough capacity for the current operation.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.InvalidDBClusterSnapshotStateException
- The supplied value is not a valid DB cluster snapshot state.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.OptionGroupNotFoundException
- The specified option group could not be found.KMSKeyNotAccessibleException
- Error accessing KMS key.
-
restoreDBInstanceFromDBSnapshot
DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Parameters:
restoreDBInstanceFromDBSnapshotRequest
-- Returns:
- Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBSnapshotNotFoundException
- DBSnapshotIdentifier does not refer to an existing DB snapshot.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.InvalidDBSnapshotStateException
- The state of the DB snapshot does not allow deletion.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DomainNotFoundException
-
restoreDBInstanceToPointInTime
DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
- Parameters:
restoreDBInstanceToPointInTimeRequest
-- Returns:
- Result of the RestoreDBInstanceToPointInTime operation returned by the service.
- Throws:
DBInstanceAlreadyExistsException
- User already has a DB instance with the given identifier.DBInstanceNotFoundException
- DBInstanceIdentifier does not refer to an existing DB instance.InstanceQuotaExceededException
- Request would result in user exceeding the allowed number of DB instances.InsufficientDBInstanceCapacityException
- Specified DB instance class is not available in the specified Availability Zone.InvalidDBInstanceStateException
- The specified DB instance is not in the available state.PointInTimeRestoreNotEnabledException
- SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.StorageQuotaExceededException
- Request would result in user exceeding the allowed amount of storage available across all DB instances.InvalidVPCNetworkStateException
- DB subnet group does not cover all Availability Zones after it is created because users' change.InvalidRestoreException
- Cannot restore from vpc backup to non-vpc DB instance.DBSubnetGroupNotFoundException
- DBSubnetGroupName does not refer to an existing DB subnet group.DBSubnetGroupDoesNotCoverEnoughAZsException
- Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException
- The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.ProvisionedIopsNotAvailableInAZException
- Provisioned IOPS not available in the specified Availability Zone.OptionGroupNotFoundException
- The specified option group could not be found.StorageTypeNotSupportedException
- StorageType specified cannot be associated with the DB Instance.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
KMSKeyNotAccessibleException
- Error accessing KMS key.DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.DomainNotFoundException
-
revokeDBSecurityGroupIngress
DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
- Parameters:
revokeDBSecurityGroupIngressRequest
-- Returns:
- Result of the RevokeDBSecurityGroupIngress operation returned by the service.
- Throws:
DBSecurityGroupNotFoundException
- DBSecurityGroupName does not refer to an existing DB security group.AuthorizationNotFoundException
- Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.RDS may not also be authorized via IAM to perform necessary actions on your behalf.
InvalidDBSecurityGroupStateException
- The state of the DB security group does not allow deletion.
-
shutdown
void shutdown()Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests. -
getCachedResponseMetadata
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-