Interface AmazonRDS

  • All Known Subinterfaces:
    AmazonRDSAsync
    All Known Implementing Classes:
    AbstractAmazonRDS, AbstractAmazonRDSAsync, AmazonRDSAsyncClient, AmazonRDSClient

    public interface AmazonRDS
    Interface for accessing Amazon RDS.

    Amazon Relational Database Service

    Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

    Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or 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

    Amazon RDS User Guide

    • Method Detail

      • setEndpoint

        void setEndpoint​(String endpoint)
        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.
      • addTagsToResource

        AddTagsToResourceResult addTagsToResource​(AddTagsToResourceRequest addTagsToResourceRequest)

        Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

        For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

        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.
      • 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.
      • 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.
      • 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.
      • deleteDBCluster

        DBCluster deleteDBCluster​(DeleteDBClusterRequest deleteDBClusterRequest)

        The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.

        For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

        Parameters:
        deleteDBClusterRequest -
        Returns:
        Result of the DeleteDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier
        InvalidDBClusterStateException - 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.
      • 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

        DBInstance deleteDBInstance​(DeleteDBInstanceRequest deleteDBInstanceRequest)

        The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

        If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

        Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

        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.
      • deleteDBSnapshot

        DBSnapshot deleteDBSnapshot​(DeleteDBSnapshotRequest deleteDBSnapshotRequest)

        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.
      • 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.
      • describeDBClusterParameterGroups

        DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups​(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)

        Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

        For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

        Parameters:
        describeDBClusterParameterGroupsRequest -
        Returns:
        Result of the DescribeDBClusterParameterGroups operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
      • describeDBClusters

        DescribeDBClustersResult describeDBClusters​(DescribeDBClustersRequest describeDBClustersRequest)

        Returns information about provisioned Aurora DB clusters. This API supports pagination.

        For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

        Parameters:
        describeDBClustersRequest -
        Returns:
        Result of the DescribeDBClusters operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier
      • 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.
      • 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.
      • describeDBLogFiles

        DescribeDBLogFilesResult describeDBLogFiles​(DescribeDBLogFilesRequest describeDBLogFilesRequest)

        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 a DBParameterGroupName 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.
      • 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 a DBSecurityGroupName 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.
      • 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 the restore attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

        To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API.

        Parameters:
        describeDBSnapshotAttributesRequest -
        Returns:
        Result of the DescribeDBSnapshotAttributes operation returned by the service.
        Throws:
        DBSnapshotNotFoundException - DBSnapshotIdentifier does not refer to an existing DB snapshot.
      • 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.
      • 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.
      • 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.
      • 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.
      • describeEvents

        DescribeEventsResult describeEvents​(DescribeEventsRequest describeEventsRequest)

        Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

        Parameters:
        describeEventsRequest -
        Returns:
        Result of the DescribeEvents operation returned by the service.
      • describeOptionGroupOptions

        DescribeOptionGroupOptionsResult describeOptionGroupOptions​(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)

        Describes all available options.

        Parameters:
        describeOptionGroupOptionsRequest -
        Returns:
        Result of the DescribeOptionGroupOptions operation returned by the service.
      • 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.
      • failoverDBCluster

        DBCluster failoverDBCluster​(FailoverDBClusterRequest failoverDBClusterRequest)

        Forces a failover for a DB cluster.

        A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.

        Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

        For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

        Parameters:
        failoverDBClusterRequest -
        Returns:
        Result of the FailoverDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier
        InvalidDBClusterStateException - The supplied value is not a valid DB cluster state.
      • 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, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

        For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

        Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

        After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

        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.
      • 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, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

        Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

        After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

        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 the AttributeName and use the ValuesToAdd parameter to add a list of the AWS account ids that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

        To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.

        If the manual DB snapshot is encrypted, it cannot be shared.

        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

        DBSubnetGroup modifyDBSubnetGroup​(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)

        Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

        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.
      • promoteReadReplica

        DBInstance promoteReadReplica​(PromoteReadReplicaRequest promoteReadReplicaRequest)

        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.
      • rebootDBInstance

        DBInstance rebootDBInstance​(RebootDBInstanceRequest rebootDBInstanceRequest)

        Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

        If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

        The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

        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.
      • 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 and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

        When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

        For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

        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 and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

        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.
      • 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
      • 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

        ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. 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.