JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.rds

Class AmazonRDSClient

  • All Implemented Interfaces:
    AmazonRDS
    Direct Known Subclasses:
    AmazonRDSAsyncClient


    @ThreadSafe
     @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
    public class AmazonRDSClient
    extends AmazonWebServiceClient
    implements AmazonRDS 
    Client for accessing Amazon RDS. All service calls made using this client are blocking, and will not return until the service call completes.

    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, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

    This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

    Amazon RDS API Reference

    Amazon RDS User Guide

    • Constructor Detail

      • AmazonRDSClient

        @Deprecated
        public AmazonRDSClient()
        Constructs a new client to invoke service methods on Amazon RDS. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain
      • AmazonRDSClient

        @Deprecated
        public AmazonRDSClient(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon RDS. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to Amazon RDS (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain
      • AmazonRDSClient

        @Deprecated
        public AmazonRDSClient(AWSCredentials awsCredentials)
        Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonRDSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
        Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      • AmazonRDSClient

        @Deprecated
        public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on Amazon RDS using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    • Method Detail

      • addSourceIdentifierToSubscription

        public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)

        Adds a source identifier to an existing RDS event notification subscription.

        Specified by:
        addSourceIdentifierToSubscription in interface AmazonRDS
        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.
        See Also:
        AWS API Documentation

        Samples:
        • To add a source identifier to an event notification subscription
          This example add a source identifier to an event notification subscription.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          AddSourceIdentifierToSubscriptionRequest request = new AddSourceIdentifierToSubscriptionRequest().withSubscriptionName("mymysqleventsubscription")
           .withSourceIdentifier("mymysqlinstance");
          EventSubscription response = client.addSourceIdentifierToSubscription(request);
      • applyPendingMaintenanceAction

        public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)

        Applies a pending maintenance action to a resource (for example, to a DB instance).

        Specified by:
        applyPendingMaintenanceAction in interface AmazonRDS
        Parameters:
        applyPendingMaintenanceActionRequest -
        Returns:
        Result of the ApplyPendingMaintenanceAction operation returned by the service.
        Throws:
        ResourceNotFoundException - The specified resource ID was not found.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        See Also:
        AWS API Documentation

        Samples:
        • To apply a pending maintenance action
          This example immediately applies a pending system update to a DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ApplyPendingMaintenanceActionRequest request = new ApplyPendingMaintenanceActionRequest()
           .withResourceIdentifier("arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance").withApplyAction("system-update").withOptInType("immediate");
          ResourcePendingMaintenanceActions response = client.applyPendingMaintenanceAction(request);
      • authorizeDBSecurityGroupIngress

        public DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest request)

        Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

        You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

        For an overview of CIDR ranges, go to the Wikipedia Tutorial.

        EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

        Specified by:
        authorizeDBSecurityGroupIngress in interface AmazonRDS
        Parameters:
        authorizeDBSecurityGroupIngressRequest -
        Returns:
        Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
        Throws:
        DBSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing DB security group.
        InvalidDBSecurityGroupStateException - The state of the DB security group doesn't allow deletion.
        AuthorizationAlreadyExistsException - The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
        AuthorizationQuotaExceededException - The DB security group authorization quota has been reached.
        See Also:
        AWS API Documentation

        Samples:
        • To authorize DB security group integress
          This example authorizes access to the specified security group by the specified CIDR block.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          AuthorizeDBSecurityGroupIngressRequest request = new AuthorizeDBSecurityGroupIngressRequest().withDBSecurityGroupName("mydbsecuritygroup").withCIDRIP(
           "203.0.113.5/32");
          DBSecurityGroup response = client.authorizeDBSecurityGroupIngress(request);
      • copyDBClusterParameterGroup

        public DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)

        Copies the specified DB cluster parameter group.

        You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.

        Specified by:
        copyDBClusterParameterGroup in interface AmazonRDS
        Parameters:
        copyDBClusterParameterGroupRequest -
        Returns:
        Result of the CopyDBClusterParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        DBParameterGroupQuotaExceededException - The request would result in the user exceeding the allowed number of DB parameter groups.
        DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.
        See Also:
        AWS API Documentation

        Samples:
        • To copy a DB cluster parameter group
          This example copies a DB cluster parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CopyDBClusterParameterGroupRequest request = new CopyDBClusterParameterGroupRequest()
           .withSourceDBClusterParameterGroupIdentifier("mydbclusterparametergroup")
           .withTargetDBClusterParameterGroupIdentifier("mydbclusterparametergroup-copy")
           .withTargetDBClusterParameterGroupDescription("My DB cluster parameter group copy");
          DBClusterParameterGroup response = client.copyDBClusterParameterGroup(request);
      • copyDBClusterSnapshot

        public DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)

        Copies a snapshot of a DB cluster.

        To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

        You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

        • KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

        • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

        • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

        To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

        For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        copyDBClusterSnapshot in interface AmazonRDS
        Parameters:
        copyDBClusterSnapshotRequest -
        Returns:
        Result of the CopyDBClusterSnapshot operation returned by the service.
        Throws:
        DBClusterSnapshotAlreadyExistsException - The user already has a DB cluster snapshot with the given identifier.
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBClusterSnapshotStateException - The supplied value isn't a valid DB cluster snapshot state.
        SnapshotQuotaExceededException - The request would result in the user exceeding the allowed number of DB snapshots.
        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        See Also:
        AWS API Documentation

        Samples:
        • To copy a DB cluster snapshot
          The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CopyDBClusterSnapshotRequest request = new CopyDBClusterSnapshotRequest().withSourceDBClusterSnapshotIdentifier("rds:sample-cluster-2016年09月14日-10-38")
           .withTargetDBClusterSnapshotIdentifier("cluster-snapshot-copy-1");
          DBClusterSnapshot response = client.copyDBClusterSnapshot(request);
      • copyDBParameterGroup

        public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest request)

        Copies the specified DB parameter group.

        You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.

        Specified by:
        copyDBParameterGroup in interface AmazonRDS
        Parameters:
        copyDBParameterGroupRequest -
        Returns:
        Result of the CopyDBParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.
        DBParameterGroupQuotaExceededException - The request would result in the user exceeding the allowed number of DB parameter groups.
        See Also:
        AWS API Documentation

        Samples:
        • To copy a DB parameter group
          This example copies a DB parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CopyDBParameterGroupRequest request = new CopyDBParameterGroupRequest().withSourceDBParameterGroupIdentifier("mymysqlparametergroup")
           .withTargetDBParameterGroupIdentifier("mymysqlparametergroup-copy").withTargetDBParameterGroupDescription("My MySQL parameter group copy");
          DBParameterGroup response = client.copyDBParameterGroup(request);
      • copyDBSnapshot

        public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest request)

        Copies the specified DB snapshot. The source DB snapshot must be in the available state.

        You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

        This command doesn't apply to RDS Custom.

        For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

        Specified by:
        copyDBSnapshot in interface AmazonRDS
        Parameters:
        copyDBSnapshotRequest -
        Returns:
        Result of the CopyDBSnapshot operation returned by the service.
        Throws:
        DBSnapshotAlreadyExistsException - DBSnapshotIdentifier is already used by an existing snapshot.
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        InvalidDBSnapshotStateException - The state of the DB snapshot doesn't allow deletion.
        SnapshotQuotaExceededException - The request would result in the user exceeding the allowed number of DB snapshots.
        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        CustomAvailabilityZoneNotFoundException - CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.
        See Also:
        AWS API Documentation

        Samples:
        • To copy a DB snapshot
          This example copies a DB snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CopyDBSnapshotRequest request = new CopyDBSnapshotRequest().withSourceDBSnapshotIdentifier("mydbsnapshot").withTargetDBSnapshotIdentifier(
           "mydbsnapshot-copy");
          DBSnapshot response = client.copyDBSnapshot(request);
      • copyOptionGroup

        public OptionGroup copyOptionGroup(CopyOptionGroupRequest request)

        Copies the specified option group.

        Specified by:
        copyOptionGroup in interface AmazonRDS
        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 Amazon Web Services account.
        See Also:
        AWS API Documentation

        Samples:
        • To copy an option group
          This example copies an option group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CopyOptionGroupRequest request = new CopyOptionGroupRequest().withSourceOptionGroupIdentifier("mymysqloptiongroup")
           .withTargetOptionGroupIdentifier("mymysqloptiongroup-copy").withTargetOptionGroupDescription("My MySQL option group copy");
          OptionGroup response = client.copyOptionGroup(request);
      • createDBCluster

        public DBCluster createDBCluster(CreateDBClusterRequest request)

        Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

        If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

        You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        createDBCluster in interface AmazonRDS
        Parameters:
        createDBClusterRequest -
        Returns:
        Result of the CreateDBCluster operation returned by the service.
        Throws:
        DBClusterAlreadyExistsException - The user already has a DB cluster with the given identifier.
        InsufficientDBInstanceCapacityException - The specified DB instance class isn't available in the specified Availability Zone.
        InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
        DBClusterQuotaExceededException - The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        InvalidVPCNetworkStateException - The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBSubnetGroupException - The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
        InvalidDBSubnetGroupStateException - The DB subnet group cannot be deleted because it's in use.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        DomainNotFoundException - Domain doesn't refer to an existing Active Directory domain.
        OptionGroupNotFoundException - The specified option group could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • To create a DB cluster
          This example creates a DB cluster.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateDBClusterRequest request = new CreateDBClusterRequest().withAvailabilityZones("us-east-1a").withBackupRetentionPeriod(1)
           .withDatabaseName("myauroradb").withDBClusterIdentifier("mydbcluster").withDBClusterParameterGroupName("mydbclusterparametergroup")
           .withEngine("aurora").withEngineVersion("5.6.10a").withPort(3306).withMasterUsername("myuser").withMasterUserPassword("mypassword")
           .withStorageEncrypted(true);
          DBCluster response = client.createDBCluster(request);
      • createDBClusterParameterGroup

        public DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)

        Creates a new DB cluster parameter group.

        Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

        A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

        When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

        When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

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

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        createDBClusterParameterGroup in interface AmazonRDS
        Parameters:
        createDBClusterParameterGroupRequest -
        Returns:
        Result of the CreateDBClusterParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupQuotaExceededException - The request would result in the user exceeding the allowed number of DB parameter groups.
        DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.
        See Also:
        AWS API Documentation

        Samples:
        • To create a DB cluster parameter group
          This example creates a DB cluster parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateDBClusterParameterGroupRequest request = new CreateDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup")
           .withDBParameterGroupFamily("aurora5.6").withDescription("My DB cluster parameter group");
          DBClusterParameterGroup response = client.createDBClusterParameterGroup(request);
      • createDBParameterGroup

        public DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest request)

        Creates a new DB parameter group.

        A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

        This command doesn't apply to RDS Custom.

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

        Specified by:
        createDBParameterGroup in interface AmazonRDS
        Parameters:
        createDBParameterGroupRequest -
        Returns:
        Result of the CreateDBParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupQuotaExceededException - The request would result in the user exceeding the allowed number of DB parameter groups.
        DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.
        See Also:
        AWS API Documentation

        Samples:
        • To create a DB parameter group.
          This example creates a DB parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateDBParameterGroupRequest request = new CreateDBParameterGroupRequest().withDBParameterGroupName("mymysqlparametergroup")
           .withDBParameterGroupFamily("mysql5.6").withDescription("My MySQL parameter group");
          DBParameterGroup response = client.createDBParameterGroup(request);
      • createDBProxyEndpoint

        public CreateDBProxyEndpointResult createDBProxyEndpoint(CreateDBProxyEndpointRequest request)

        Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

        Specified by:
        createDBProxyEndpoint in interface AmazonRDS
        Parameters:
        createDBProxyEndpointRequest -
        Returns:
        Result of the CreateDBProxyEndpoint operation returned by the service.
        Throws:
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        DBProxyNotFoundException - The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
        DBProxyEndpointAlreadyExistsException - The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
        DBProxyEndpointQuotaExceededException - The DB proxy already has the maximum number of endpoints.
        InvalidDBProxyStateException - The requested operation can't be performed while the proxy is in this state.
        See Also:
        AWS API Documentation
      • createDBSnapshot

        public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest request)

        Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

        Specified by:
        createDBSnapshot in interface AmazonRDS
        Parameters:
        createDBSnapshotRequest -
        Returns:
        Result of the CreateDBSnapshot operation returned by the service.
        Throws:
        DBSnapshotAlreadyExistsException - DBSnapshotIdentifier is already used by an existing snapshot.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        SnapshotQuotaExceededException - The request would result in the user exceeding the allowed number of DB snapshots.
        See Also:
        AWS API Documentation

        Samples:
        • To create a DB snapshot.
          This example creates a DB snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateDBSnapshotRequest request = new CreateDBSnapshotRequest().withDBSnapshotIdentifier("mydbsnapshot").withDBInstanceIdentifier("mymysqlinstance");
          DBSnapshot response = client.createDBSnapshot(request);
      • createDBSubnetGroup

        public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest request)

        Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

        Specified by:
        createDBSubnetGroup in interface AmazonRDS
        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 - The request would result in the user exceeding the allowed number of DB subnet groups.
        DBSubnetQuotaExceededException - The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
        DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        See Also:
        AWS API Documentation

        Samples:
        • To create a DB subnet group.
          This example creates a DB subnet group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateDBSubnetGroupRequest request = new CreateDBSubnetGroupRequest().withDBSubnetGroupName("mydbsubnetgroup")
           .withDBSubnetGroupDescription("My DB subnet group").withSubnetIds("subnet-1fab8a69", "subnet-d43a468c");
          DBSubnetGroup response = client.createDBSubnetGroup(request);
      • createEventSubscription

        public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)

        Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

        You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

        If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

        For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

        For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

        Specified by:
        createEventSubscription in interface AmazonRDS
        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 SNS topic specified.
        SNSNoAuthorizationException - You do not have permission to publish to the SNS topic ARN.
        SNSTopicArnNotFoundException - The SNS topic ARN does not exist.
        SubscriptionCategoryNotFoundException - The supplied category does not exist.
        SourceNotFoundException - The requested source could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • To create an event notification subscription
          This example creates an event notification subscription.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateEventSubscriptionRequest request = new CreateEventSubscriptionRequest().withSubscriptionName("mymysqleventsubscription")
           .withSnsTopicArn("arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic").withSourceType("db-instance").withEventCategories("availability")
           .withSourceIds("mymysqlinstance").withEnabled(true);
          EventSubscription response = client.createEventSubscription(request);
      • createGlobalCluster

        public GlobalCluster createGlobalCluster(CreateGlobalClusterRequest request)

        Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

        You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

        This operation applies only to Aurora DB clusters.

        Specified by:
        createGlobalCluster in interface AmazonRDS
        Parameters:
        createGlobalClusterRequest -
        Returns:
        Result of the CreateGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterAlreadyExistsException - The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
        GlobalClusterQuotaExceededException - The number of global database clusters for this account is already at the maximum allowed.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        See Also:
        AWS API Documentation
      • createOptionGroup

        public OptionGroup createOptionGroup(CreateOptionGroupRequest request)

        Creates a new option group. You can create up to 20 option groups.

        This command doesn't apply to RDS Custom.

        Specified by:
        createOptionGroup in interface AmazonRDS
        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 Amazon Web Services account.
        See Also:
        AWS API Documentation

        Samples:
        • To create an option group
          This example creates an option group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          CreateOptionGroupRequest request = new CreateOptionGroupRequest().withOptionGroupName("mymysqloptiongroup").withEngineName("MySQL")
           .withMajorEngineVersion("5.6").withOptionGroupDescription("My MySQL 5.6 option group");
          OptionGroup response = client.createOptionGroup(request);
      • deleteCustomDBEngineVersion

        public DeleteCustomDBEngineVersionResult deleteCustomDBEngineVersion(DeleteCustomDBEngineVersionRequest request)

        Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

        • The CEV must not be the default for RDS Custom. If it is, change the default before running this command.

        • The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

        Typically, deletion takes a few minutes.

        The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.

        For more information, see Deleting a CEV in the Amazon RDS User Guide.

        Specified by:
        deleteCustomDBEngineVersion in interface AmazonRDS
        Parameters:
        deleteCustomDBEngineVersionRequest -
        Returns:
        Result of the DeleteCustomDBEngineVersion operation returned by the service.
        Throws:
        CustomDBEngineVersionNotFoundException - The specified CEV was not found.
        InvalidCustomDBEngineVersionStateException - You can't delete the CEV.
        See Also:
        AWS API Documentation
      • deleteDBCluster

        public DBCluster deleteDBCluster(DeleteDBClusterRequest request)

        The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

        If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        deleteDBCluster in interface AmazonRDS
        Parameters:
        deleteDBClusterRequest -
        Returns:
        Result of the DeleteDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        DBClusterSnapshotAlreadyExistsException - The user already has a DB cluster snapshot with the given identifier.
        SnapshotQuotaExceededException - The request would result in the user exceeding the allowed number of DB snapshots.
        InvalidDBClusterSnapshotStateException - The supplied value isn't a valid DB cluster snapshot state.
        DBClusterAutomatedBackupQuotaExceededException - The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB cluster.
          This example deletes the specified DB cluster.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBClusterRequest request = new DeleteDBClusterRequest().withDBClusterIdentifier("mydbcluster").withSkipFinalSnapshot(true);
          DBCluster response = client.deleteDBCluster(request);
      • deleteDBClusterParameterGroup

        public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)

        Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        deleteDBClusterParameterGroup in interface AmazonRDS
        Parameters:
        deleteDBClusterParameterGroupRequest -
        Returns:
        Result of the DeleteDBClusterParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB cluster parameter group.
          This example deletes the specified DB cluster parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBClusterParameterGroupRequest request = new DeleteDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup");
          DeleteDBClusterParameterGroupResult response = client.deleteDBClusterParameterGroup(request);
      • deleteDBClusterSnapshot

        public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)

        Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

        The DB cluster snapshot must be in the available state to be deleted.

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        deleteDBClusterSnapshot in interface AmazonRDS
        Parameters:
        deleteDBClusterSnapshotRequest -
        Returns:
        Result of the DeleteDBClusterSnapshot operation returned by the service.
        Throws:
        InvalidDBClusterSnapshotStateException - The supplied value isn't a valid DB cluster snapshot state.
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB cluster snapshot.
          This example deletes the specified DB cluster snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBClusterSnapshotRequest request = new DeleteDBClusterSnapshotRequest().withDBClusterSnapshotIdentifier("mydbclustersnapshot");
          DBClusterSnapshot response = client.deleteDBClusterSnapshot(request);
      • deleteDBInstance

        public DBInstance deleteDBInstance(DeleteDBInstanceRequest request)

        Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.

        If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.

        When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

        If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

        • The DB cluster is a read replica of another Amazon Aurora DB cluster.

        • The DB instance is the only instance in the DB cluster.

        To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.

        For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.

        Specified by:
        deleteDBInstance in interface AmazonRDS
        Parameters:
        deleteDBInstanceRequest -
        Returns:
        Result of the DeleteDBInstance operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        DBSnapshotAlreadyExistsException - DBSnapshotIdentifier is already used by an existing snapshot.
        SnapshotQuotaExceededException - The request would result in the user exceeding the allowed number of DB snapshots.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        DBInstanceAutomatedBackupQuotaExceededException - The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB instance.
          This example deletes the specified DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBInstanceRequest request = new DeleteDBInstanceRequest().withDBInstanceIdentifier("mymysqlinstance").withSkipFinalSnapshot(true);
          DBInstance response = client.deleteDBInstance(request);
      • deleteDBParameterGroup

        public DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest request)

        Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

        Specified by:
        deleteDBParameterGroup in interface AmazonRDS
        Parameters:
        deleteDBParameterGroupRequest -
        Returns:
        Result of the DeleteDBParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB parameter group
          The following example deletes a DB parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBParameterGroupRequest request = new DeleteDBParameterGroupRequest().withDBParameterGroupName("mydbparamgroup3");
          DeleteDBParameterGroupResult response = client.deleteDBParameterGroup(request);
      • deleteDBSnapshot

        public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest request)

        Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

        The DB snapshot must be in the available state to be deleted.

        Specified by:
        deleteDBSnapshot in interface AmazonRDS
        Parameters:
        deleteDBSnapshotRequest -
        Returns:
        Result of the DeleteDBSnapshot operation returned by the service.
        Throws:
        InvalidDBSnapshotStateException - The state of the DB snapshot doesn't allow deletion.
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB cluster snapshot.
          This example deletes the specified DB snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBSnapshotRequest request = new DeleteDBSnapshotRequest().withDBSnapshotIdentifier("mydbsnapshot");
          DBSnapshot response = client.deleteDBSnapshot(request);
      • deleteDBSubnetGroup

        public DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)

        Deletes a DB subnet group.

        The specified database subnet group must not be associated with any DB instances.

        Specified by:
        deleteDBSubnetGroup in interface AmazonRDS
        Parameters:
        deleteDBSubnetGroupRequest -
        Returns:
        Result of the DeleteDBSubnetGroup operation returned by the service.
        Throws:
        InvalidDBSubnetGroupStateException - The DB subnet group cannot be deleted because it's in use.
        InvalidDBSubnetStateException - The DB subnet isn't in the available state.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB subnet group.
          This example deletes the specified DB subnetgroup.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteDBSubnetGroupRequest request = new DeleteDBSubnetGroupRequest().withDBSubnetGroupName("mydbsubnetgroup");
          DeleteDBSubnetGroupResult response = client.deleteDBSubnetGroup(request);
      • deleteEventSubscription

        public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest request)

        Deletes an RDS event notification subscription.

        Specified by:
        deleteEventSubscription in interface AmazonRDS
        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.
        See Also:
        AWS API Documentation

        Samples:
        • To delete a DB event subscription.
          This example deletes the specified DB event subscription.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteEventSubscriptionRequest request = new DeleteEventSubscriptionRequest().withSubscriptionName("myeventsubscription");
          EventSubscription response = client.deleteEventSubscription(request);
      • deleteOptionGroup

        public DeleteOptionGroupResult deleteOptionGroup(DeleteOptionGroupRequest request)

        Deletes an existing option group.

        Specified by:
        deleteOptionGroup in interface AmazonRDS
        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 isn't in the available state.
        See Also:
        AWS API Documentation

        Samples:
        • To delete an option group.
          This example deletes the specified option group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DeleteOptionGroupRequest request = new DeleteOptionGroupRequest().withOptionGroupName("mydboptiongroup");
          DeleteOptionGroupResult response = client.deleteOptionGroup(request);
      • describeAccountAttributes

        public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)

        Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

        This command doesn't take any parameters.

        Specified by:
        describeAccountAttributes in interface AmazonRDS
        Parameters:
        describeAccountAttributesRequest -
        Returns:
        Result of the DescribeAccountAttributes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list account attributes
          This example lists account attributes.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest();
          DescribeAccountAttributesResult response = client.describeAccountAttributes(request);
      • describeDBClusterParameterGroups

        public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)

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

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        describeDBClusterParameterGroups in interface AmazonRDS
        Parameters:
        describeDBClusterParameterGroupsRequest -
        Returns:
        Result of the DescribeDBClusterParameterGroups operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB cluster parameter group settings
          This example lists settings for the specified DB cluster parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBClusterParameterGroupsRequest request = new DescribeDBClusterParameterGroupsRequest()
           .withDBClusterParameterGroupName("mydbclusterparametergroup");
          DescribeDBClusterParameterGroupsResult response = client.describeDBClusterParameterGroups(request);
      • describeDBClusterParameters

        public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest request)

        Returns the detailed parameter list for a particular DB cluster parameter group.

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        describeDBClusterParameters in interface AmazonRDS
        Parameters:
        describeDBClusterParametersRequest -
        Returns:
        Result of the DescribeDBClusterParameters operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB cluster parameters
          This example lists system parameters for the specified DB cluster parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBClusterParametersRequest request = new DescribeDBClusterParametersRequest().withDBClusterParameterGroupName("mydbclusterparametergroup")
           .withSource("system");
          DescribeDBClusterParametersResult response = client.describeDBClusterParameters(request);
      • describeDBClusterSnapshotAttributes

        public DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)

        Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

        When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

        To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

        Specified by:
        describeDBClusterSnapshotAttributes in interface AmazonRDS
        Parameters:
        describeDBClusterSnapshotAttributesRequest -
        Returns:
        Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
        Throws:
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB cluster snapshot attributes
          This example lists attributes for the specified DB cluster snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBClusterSnapshotAttributesRequest request = new DescribeDBClusterSnapshotAttributesRequest()
           .withDBClusterSnapshotIdentifier("mydbclustersnapshot");
          DBClusterSnapshotAttributesResult response = client.describeDBClusterSnapshotAttributes(request);
      • describeDBClusterSnapshots

        public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)

        Returns information about DB cluster snapshots. This API action supports pagination.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        describeDBClusterSnapshots in interface AmazonRDS
        Parameters:
        describeDBClusterSnapshotsRequest -
        Returns:
        Result of the DescribeDBClusterSnapshots operation returned by the service.
        Throws:
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB cluster snapshots
          This example lists settings for the specified, manually-created cluster snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBClusterSnapshotsRequest request = new DescribeDBClusterSnapshotsRequest().withDBClusterSnapshotIdentifier("mydbclustersnapshot")
           .withSnapshotType("manual");
          DescribeDBClusterSnapshotsResult response = client.describeDBClusterSnapshots(request);
      • describeDBClusters

        public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest request)

        Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

        Specified by:
        describeDBClusters in interface AmazonRDS
        Parameters:
        describeDBClustersRequest -
        Returns:
        Result of the DescribeDBClusters operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB clusters
          This example lists settings for the specified DB cluster.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBClustersRequest request = new DescribeDBClustersRequest().withDBClusterIdentifier("mynewdbcluster");
          DescribeDBClustersResult response = client.describeDBClusters(request);
      • describeDBEngineVersions

        public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest request)

        Describes the properties of specific versions of DB engines.

        Specified by:
        describeDBEngineVersions in interface AmazonRDS
        Parameters:
        describeDBEngineVersionsRequest -
        Returns:
        Result of the DescribeDBEngineVersions operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB engine version settings
          This example lists settings for the specified DB engine version.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBEngineVersionsRequest request = new DescribeDBEngineVersionsRequest().withEngine("mysql").withEngineVersion("5.6")
           .withDBParameterGroupFamily("mysql5.6").withDefaultOnly(true).withListSupportedCharacterSets(true);
          DescribeDBEngineVersionsResult response = client.describeDBEngineVersions(request);
      • describeDBInstanceAutomatedBackups

        public DescribeDBInstanceAutomatedBackupsResult describeDBInstanceAutomatedBackups(DescribeDBInstanceAutomatedBackupsRequest request)

        Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

        All parameters are optional.

        Specified by:
        describeDBInstanceAutomatedBackups in interface AmazonRDS
        Parameters:
        describeDBInstanceAutomatedBackupsRequest - Parameter input for DescribeDBInstanceAutomatedBackups.
        Returns:
        Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
        Throws:
        DBInstanceAutomatedBackupNotFoundException - No automated backup for this DB instance was found.
        See Also:
        AWS API Documentation
      • describeDBInstances

        public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)

        Describes provisioned RDS instances. This API supports pagination.

        This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

        Specified by:
        describeDBInstances in interface AmazonRDS
        Parameters:
        describeDBInstancesRequest -
        Returns:
        Result of the DescribeDBInstances operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB instance settings
          This example lists settings for the specified DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBInstancesRequest request = new DescribeDBInstancesRequest().withDBInstanceIdentifier("mymysqlinstance");
          DescribeDBInstancesResult response = client.describeDBInstances(request);
      • describeDBLogFiles

        public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest request)

        Returns a list of DB log files for the DB instance.

        This command doesn't apply to RDS Custom.

        Specified by:
        describeDBLogFiles in interface AmazonRDS
        Parameters:
        describeDBLogFilesRequest -
        Returns:
        Result of the DescribeDBLogFiles operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB log file names
          This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX time with milleseconds, and minimum file size.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBLogFilesRequest request = new DescribeDBLogFilesRequest().withDBInstanceIdentifier("mymysqlinstance").withFilenameContains("error")
           .withFileLastWritten(1470873600000L).withFileSize(0L);
          DescribeDBLogFilesResult response = client.describeDBLogFiles(request);
      • describeDBParameterGroups

        public DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest request)

        Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

        Specified by:
        describeDBParameterGroups in interface AmazonRDS
        Parameters:
        describeDBParameterGroupsRequest -
        Returns:
        Result of the DescribeDBParameterGroups operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB parameter groups
          This example lists information about the specified DB parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBParameterGroupsRequest request = new DescribeDBParameterGroupsRequest().withDBParameterGroupName("mymysqlparametergroup");
          DescribeDBParameterGroupsResult response = client.describeDBParameterGroups(request);
      • describeDBParameters

        public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest request)

        Returns the detailed parameter list for a particular DB parameter group.

        Specified by:
        describeDBParameters in interface AmazonRDS
        Parameters:
        describeDBParametersRequest -
        Returns:
        Result of the DescribeDBParameters operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB parameters
          This example lists information for up to the first 20 system parameters for the specified DB parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBParametersRequest request = new DescribeDBParametersRequest().withDBParameterGroupName("mymysqlparametergroup").withSource("system")
           .withMaxRecords(20);
          DescribeDBParametersResult response = client.describeDBParameters(request);
      • describeDBSnapshotAttributes

        public DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest request)

        Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

        When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

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

        Specified by:
        describeDBSnapshotAttributes in interface AmazonRDS
        Parameters:
        describeDBSnapshotAttributesRequest -
        Returns:
        Result of the DescribeDBSnapshotAttributes operation returned by the service.
        Throws:
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB snapshot attributes
          This example lists attributes for the specified DB snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBSnapshotAttributesRequest request = new DescribeDBSnapshotAttributesRequest().withDBSnapshotIdentifier("mydbsnapshot");
          DBSnapshotAttributesResult response = client.describeDBSnapshotAttributes(request);
      • describeDBSnapshotTenantDatabases

        public DescribeDBSnapshotTenantDatabasesResult describeDBSnapshotTenantDatabases(DescribeDBSnapshotTenantDatabasesRequest request)

        Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.

        You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

        Specified by:
        describeDBSnapshotTenantDatabases in interface AmazonRDS
        Parameters:
        describeDBSnapshotTenantDatabasesRequest -
        Returns:
        Result of the DescribeDBSnapshotTenantDatabases operation returned by the service.
        Throws:
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        See Also:
        AWS API Documentation
      • describeDBSnapshots

        public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest request)

        Returns information about DB snapshots. This API action supports pagination.

        Specified by:
        describeDBSnapshots in interface AmazonRDS
        Parameters:
        describeDBSnapshotsRequest -
        Returns:
        Result of the DescribeDBSnapshots operation returned by the service.
        Throws:
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        See Also:
        AWS API Documentation

        Samples:
        • To list DB snapshot attributes
          This example lists all manually-created, shared snapshots for the specified DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBSnapshotsRequest request = new DescribeDBSnapshotsRequest().withDBInstanceIdentifier("mymysqlinstance").withSnapshotType("manual")
           .withIncludeShared(true).withIncludePublic(false);
          DescribeDBSnapshotsResult response = client.describeDBSnapshots(request);
      • describeDBSubnetGroups

        public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)

        Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

        For an overview of CIDR ranges, go to the Wikipedia Tutorial.

        Specified by:
        describeDBSubnetGroups in interface AmazonRDS
        Parameters:
        describeDBSubnetGroupsRequest -
        Returns:
        Result of the DescribeDBSubnetGroups operation returned by the service.
        Throws:
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB subnet groups
          This example lists information about the specified DB subnet group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeDBSubnetGroupsRequest request = new DescribeDBSubnetGroupsRequest().withDBSubnetGroupName("mydbsubnetgroup");
          DescribeDBSubnetGroupsResult response = client.describeDBSubnetGroups(request);
      • describeEngineDefaultClusterParameters

        public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)

        Returns the default engine and system parameter information for the cluster database engine.

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        Specified by:
        describeEngineDefaultClusterParameters in interface AmazonRDS
        Parameters:
        describeEngineDefaultClusterParametersRequest -
        Returns:
        Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list default parameters for a DB cluster engine
          This example lists default parameters for the specified DB cluster engine.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeEngineDefaultClusterParametersRequest request = new DescribeEngineDefaultClusterParametersRequest().withDBParameterGroupFamily("aurora5.6");
          EngineDefaults response = client.describeEngineDefaultClusterParameters(request);
      • describeEngineDefaultParameters

        public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)

        Returns the default engine and system parameter information for the specified database engine.

        Specified by:
        describeEngineDefaultParameters in interface AmazonRDS
        Parameters:
        describeEngineDefaultParametersRequest -
        Returns:
        Result of the DescribeEngineDefaultParameters operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list default parameters for a DB engine
          This example lists default parameters for the specified DB engine.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeEngineDefaultParametersRequest request = new DescribeEngineDefaultParametersRequest().withDBParameterGroupFamily("mysql5.6");
          EngineDefaults response = client.describeEngineDefaultParameters(request);
      • describeEventCategories

        public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)

        Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .

        Specified by:
        describeEventCategories in interface AmazonRDS
        Parameters:
        describeEventCategoriesRequest -
        Returns:
        Result of the DescribeEventCategories operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list event categories.
          This example lists all DB instance event categories.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeEventCategoriesRequest request = new DescribeEventCategoriesRequest().withSourceType("db-instance");
          DescribeEventCategoriesResult response = client.describeEventCategories(request);
      • describeEventSubscriptions

        public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)

        Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

        If you specify a SubscriptionName, lists the description for that subscription.

        Specified by:
        describeEventSubscriptions in interface AmazonRDS
        Parameters:
        describeEventSubscriptionsRequest -
        Returns:
        Result of the DescribeEventSubscriptions operation returned by the service.
        Throws:
        SubscriptionNotFoundException - The subscription name does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB event notification subscriptions
          This example lists information for the specified DB event notification subscription.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeEventSubscriptionsRequest request = new DescribeEventSubscriptionsRequest().withSubscriptionName("mymysqleventsubscription");
          DescribeEventSubscriptionsResult response = client.describeEventSubscriptions(request);
      • describeEvents

        public DescribeEventsResult describeEvents(DescribeEventsRequest request)

        Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

        For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.

        By default, RDS returns events that were generated in the past hour.

        Specified by:
        describeEvents in interface AmazonRDS
        Parameters:
        describeEventsRequest -
        Returns:
        Result of the DescribeEvents operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about events
          This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeEventsRequest request = new DescribeEventsRequest().withSourceIdentifier("mymysqlinstance").withSourceType("db-instance").withDuration(10080)
           .withEventCategories("backup");
          DescribeEventsResult response = client.describeEvents(request);
      • describeOptionGroupOptions

        public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest request)

        Describes all available options for the specified engine.

        Specified by:
        describeOptionGroupOptions in interface AmazonRDS
        Parameters:
        describeOptionGroupOptionsRequest -
        Returns:
        Result of the DescribeOptionGroupOptions operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB option group options
          This example lists information for all option group options for the specified DB engine.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeOptionGroupOptionsRequest request = new DescribeOptionGroupOptionsRequest().withEngineName("mysql").withMajorEngineVersion("5.6");
          DescribeOptionGroupOptionsResult response = client.describeOptionGroupOptions(request);
      • describeOptionGroups

        public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest request)

        Describes the available option groups.

        Specified by:
        describeOptionGroups in interface AmazonRDS
        Parameters:
        describeOptionGroupsRequest -
        Returns:
        Result of the DescribeOptionGroups operation returned by the service.
        Throws:
        OptionGroupNotFoundException - The specified option group could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB option groups
          This example lists information for all option groups for the specified DB engine.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeOptionGroupsRequest request = new DescribeOptionGroupsRequest().withEngineName("mysql").withMajorEngineVersion("5.6");
          DescribeOptionGroupsResult response = client.describeOptionGroups(request);
      • describeOrderableDBInstanceOptions

        public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)

        Describes the orderable DB instance options for a specified DB engine.

        Specified by:
        describeOrderableDBInstanceOptions in interface AmazonRDS
        Parameters:
        describeOrderableDBInstanceOptionsRequest -
        Returns:
        Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about orderable DB instance options
          This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB instance class, license model, and VPC settings.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeOrderableDBInstanceOptionsRequest request = new DescribeOrderableDBInstanceOptionsRequest().withEngine("mysql").withEngineVersion("5.6.27")
           .withDBInstanceClass("db.t2.micro").withLicenseModel("general-public-license").withVpc(true);
          DescribeOrderableDBInstanceOptionsResult response = client.describeOrderableDBInstanceOptions(request);
      • describePendingMaintenanceActions

        public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)

        Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

        This API follows an eventual consistency model. This means that the result of the DescribePendingMaintenanceActions command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use DescribePendingMaintenanceActions immediately after using a previous API command such as ApplyPendingMaintenanceActions.

        Specified by:
        describePendingMaintenanceActions in interface AmazonRDS
        Parameters:
        describePendingMaintenanceActionsRequest -
        Returns:
        Result of the DescribePendingMaintenanceActions operation returned by the service.
        Throws:
        ResourceNotFoundException - The specified resource ID was not found.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about pending maintenance actions
          This example lists information for all pending maintenance actions for the specified DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribePendingMaintenanceActionsRequest request = new DescribePendingMaintenanceActionsRequest()
           .withResourceIdentifier("arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance");
          DescribePendingMaintenanceActionsResult response = client.describePendingMaintenanceActions(request);
      • describeReservedDBInstances

        public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest request)

        Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

        Specified by:
        describeReservedDBInstances in interface AmazonRDS
        Parameters:
        describeReservedDBInstancesRequest -
        Returns:
        Result of the DescribeReservedDBInstances operation returned by the service.
        Throws:
        ReservedDBInstanceNotFoundException - The specified reserved DB Instance not found.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about reserved DB instances
          This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeReservedDBInstancesRequest request = new DescribeReservedDBInstancesRequest().withDBInstanceClass("db.t2.micro").withDuration("1y")
           .withProductDescription("mysql").withOfferingType("No Upfront").withMultiAZ(false);
          DescribeReservedDBInstancesResult response = client.describeReservedDBInstances(request);
      • describeReservedDBInstancesOfferings

        public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest request)

        Lists available reserved DB instance offerings.

        Specified by:
        describeReservedDBInstancesOfferings in interface AmazonRDS
        Parameters:
        describeReservedDBInstancesOfferingsRequest -
        Returns:
        Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
        Throws:
        ReservedDBInstancesOfferingNotFoundException - Specified offering does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about reserved DB instance offerings
          This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeReservedDBInstancesOfferingsRequest request = new DescribeReservedDBInstancesOfferingsRequest().withDBInstanceClass("db.t2.micro")
           .withDuration("1y").withProductDescription("mysql").withOfferingType("No Upfront").withMultiAZ(false);
          DescribeReservedDBInstancesOfferingsResult response = client.describeReservedDBInstancesOfferings(request);
      • describeSourceRegions

        public DescribeSourceRegionsResult describeSourceRegions(DescribeSourceRegionsRequest request)

        Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.

        Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.

        To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.

        Specified by:
        describeSourceRegions in interface AmazonRDS
        Parameters:
        describeSourceRegionsRequest -
        Returns:
        Result of the DescribeSourceRegions operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • To describe source regions
          To list the AWS regions where a Read Replica can be created.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DescribeSourceRegionsRequest request = new DescribeSourceRegionsRequest();
          DescribeSourceRegionsResult response = client.describeSourceRegions(request);
      • disableHttpEndpoint

        public DisableHttpEndpointResult disableHttpEndpoint(DisableHttpEndpointRequest request)

        Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.

        For more information, see Using RDS Data API in the Amazon Aurora User Guide.

        This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

        Specified by:
        disableHttpEndpoint in interface AmazonRDS
        Parameters:
        disableHttpEndpointRequest -
        Returns:
        Result of the DisableHttpEndpoint operation returned by the service.
        Throws:
        ResourceNotFoundException - The specified resource ID was not found.
        InvalidResourceStateException - The operation can't be performed because another operation is in progress.
        See Also:
        AWS API Documentation
      • downloadDBLogFilePortion

        public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest request)

        Downloads all or a portion of the specified log file, up to 1 MB in size.

        This command doesn't apply to RDS Custom.

        Specified by:
        downloadDBLogFilePortion in interface AmazonRDS
        Parameters:
        downloadDBLogFilePortionRequest -
        Returns:
        Result of the DownloadDBLogFilePortion operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        DBLogFileNotFoundException - LogFileName doesn't refer to an existing DB log file.
        See Also:
        AWS API Documentation

        Samples:
        • To list information about DB log files
          This example lists information for the specified log file for the specified DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          DownloadDBLogFilePortionRequest request = new DownloadDBLogFilePortionRequest().withDBInstanceIdentifier("mymysqlinstance").withLogFileName(
           "mysqlUpgrade");
          DownloadDBLogFilePortionResult response = client.downloadDBLogFilePortion(request);
      • enableHttpEndpoint

        public EnableHttpEndpointResult enableHttpEndpoint(EnableHttpEndpointRequest request)

        Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

        When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

        For more information, see Using RDS Data API in the Amazon Aurora User Guide.

        This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

        Specified by:
        enableHttpEndpoint in interface AmazonRDS
        Parameters:
        enableHttpEndpointRequest -
        Returns:
        Result of the EnableHttpEndpoint operation returned by the service.
        Throws:
        ResourceNotFoundException - The specified resource ID was not found.
        InvalidResourceStateException - The operation can't be performed because another operation is in progress.
        See Also:
        AWS API Documentation
      • failoverDBCluster

        public DBCluster failoverDBCluster(FailoverDBClusterRequest request)

        Forces a failover for a DB cluster.

        For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

        For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.

        An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

        To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        failoverDBCluster in interface AmazonRDS
        Parameters:
        failoverDBClusterRequest -
        Returns:
        Result of the FailoverDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        See Also:
        AWS API Documentation

        Samples:
        • To perform a failover for a DB cluster
          This example performs a failover for the specified DB cluster to the specified DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          FailoverDBClusterRequest request = new FailoverDBClusterRequest().withDBClusterIdentifier("myaurorainstance-cluster").withTargetDBInstanceIdentifier(
           "myaurorareplica");
          DBCluster response = client.failoverDBCluster(request);
      • failoverGlobalCluster

        public GlobalCluster failoverGlobalCluster(FailoverGlobalClusterRequest request)

        Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."

        Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.

        How you use this operation depends on whether you are failing over or switching over your global database cluster:

        • Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.

        • Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.

        About failing over and switching over

        While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:

        • Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

          For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.

        • Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.

          For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.

        Specified by:
        failoverGlobalCluster in interface AmazonRDS
        Parameters:
        failoverGlobalClusterRequest -
        Returns:
        Result of the FailoverGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        See Also:
        AWS API Documentation
      • modifyCertificates

        public Certificate modifyCertificates(ModifyCertificatesRequest request)

        Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

        By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

        You might need to override the default certificate in the following situations:

        • You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.

        • RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

        For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

        For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

        Specified by:
        modifyCertificates in interface AmazonRDS
        Parameters:
        modifyCertificatesRequest -
        Returns:
        Result of the ModifyCertificates operation returned by the service.
        Throws:
        CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.
        See Also:
        AWS API Documentation
      • modifyCurrentDBClusterCapacity

        public ModifyCurrentDBClusterCapacityResult modifyCurrentDBClusterCapacity(ModifyCurrentDBClusterCapacityRequest request)

        Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

        Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

        After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

        For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

        If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

        This operation only applies to Aurora Serverless v1 DB clusters.

        Specified by:
        modifyCurrentDBClusterCapacity in interface AmazonRDS
        Parameters:
        modifyCurrentDBClusterCapacityRequest -
        Returns:
        Result of the ModifyCurrentDBClusterCapacity operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBClusterCapacityException - Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.
        See Also:
        AWS API Documentation
      • modifyCustomDBEngineVersion

        public ModifyCustomDBEngineVersionResult modifyCustomDBEngineVersion(ModifyCustomDBEngineVersionRequest request)

        Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

        The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.

        For more information, see Modifying CEV status in the Amazon RDS User Guide.

        Specified by:
        modifyCustomDBEngineVersion in interface AmazonRDS
        Parameters:
        modifyCustomDBEngineVersionRequest -
        Returns:
        Result of the ModifyCustomDBEngineVersion operation returned by the service.
        Throws:
        CustomDBEngineVersionNotFoundException - The specified CEV was not found.
        InvalidCustomDBEngineVersionStateException - You can't delete the CEV.
        See Also:
        AWS API Documentation
      • modifyDBClusterParameterGroup

        public ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)

        Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

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

        If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        modifyDBClusterParameterGroup in interface AmazonRDS
        Parameters:
        modifyDBClusterParameterGroupRequest -
        Returns:
        Result of the ModifyDBClusterParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
        See Also:
        AWS API Documentation

        Samples:
        • To change DB cluster parameter group settings
          This example immediately changes the specified setting for the specified DB cluster parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyDBClusterParameterGroupRequest request = new ModifyDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup")
           .withParameters(new Parameter().withParameterName("time_zone").withParameterValue("America/Phoenix").withApplyMethod("immediate"));
          ModifyDBClusterParameterGroupResult response = client.modifyDBClusterParameterGroup(request);
      • modifyDBClusterSnapshotAttribute

        public DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)

        Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

        To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.

        Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

        If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

        To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

        Specified by:
        modifyDBClusterSnapshotAttribute in interface AmazonRDS
        Parameters:
        modifyDBClusterSnapshotAttributeRequest -
        Returns:
        Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
        Throws:
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        InvalidDBClusterSnapshotStateException - The supplied value isn't a valid DB cluster snapshot state.
        SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
        See Also:
        AWS API Documentation

        Samples:
        • To add or remove access to a manual DB cluster snapshot
          The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyDBClusterSnapshotAttributeRequest request = new ModifyDBClusterSnapshotAttributeRequest()
           .withDBClusterSnapshotIdentifier("manual-cluster-snapshot1").withAttributeName("restore").withValuesToAdd("123451234512", "123456789012")
           .withValuesToRemove("all");
          DBClusterSnapshotAttributesResult response = client.modifyDBClusterSnapshotAttribute(request);
      • modifyDBParameterGroup

        public ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest request)

        Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

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

        Specified by:
        modifyDBParameterGroup in interface AmazonRDS
        Parameters:
        modifyDBParameterGroupRequest -
        Returns:
        Result of the ModifyDBParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
        See Also:
        AWS API Documentation

        Samples:
        • To change DB parameter group settings
          This example immediately changes the specified setting for the specified DB parameter group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyDBParameterGroupRequest request = new ModifyDBParameterGroupRequest().withDBParameterGroupName("mymysqlparametergroup").withParameters(
           new Parameter().withParameterName("time_zone").withParameterValue("America/Phoenix").withApplyMethod("immediate"));
          ModifyDBParameterGroupResult response = client.modifyDBParameterGroup(request);
      • modifyDBSnapshot

        public DBSnapshot modifyDBSnapshot(ModifyDBSnapshotRequest request)

        Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

        Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.

        Specified by:
        modifyDBSnapshot in interface AmazonRDS
        Parameters:
        modifyDBSnapshotRequest -
        Returns:
        Result of the ModifyDBSnapshot operation returned by the service.
        Throws:
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        See Also:
        AWS API Documentation
      • modifyDBSnapshotAttribute

        public DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest request)

        Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

        To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

        Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

        If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

        To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

        Specified by:
        modifyDBSnapshotAttribute in interface AmazonRDS
        Parameters:
        modifyDBSnapshotAttributeRequest -
        Returns:
        Result of the ModifyDBSnapshotAttribute operation returned by the service.
        Throws:
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        InvalidDBSnapshotStateException - The state of the DB snapshot doesn't allow deletion.
        SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
        See Also:
        AWS API Documentation

        Samples:
        • To change DB snapshot attributes
          This example adds the specified attribute for the specified DB snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyDBSnapshotAttributeRequest request = new ModifyDBSnapshotAttributeRequest().withDBSnapshotIdentifier("mydbsnapshot").withAttributeName("restore")
           .withValuesToAdd("all");
          DBSnapshotAttributesResult response = client.modifyDBSnapshotAttribute(request);
      • modifyDBSubnetGroup

        public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)

        Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

        Specified by:
        modifyDBSubnetGroup in interface AmazonRDS
        Parameters:
        modifyDBSubnetGroupRequest -
        Returns:
        Result of the ModifyDBSubnetGroup operation returned by the service.
        Throws:
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        DBSubnetQuotaExceededException - The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
        SubnetAlreadyInUseException - The DB subnet is already in use in the Availability Zone.
        DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        See Also:
        AWS API Documentation

        Samples:
        • To change DB subnet group settings
          This example changes the specified setting for the specified DB subnet group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyDBSubnetGroupRequest request = new ModifyDBSubnetGroupRequest().withDBSubnetGroupName("mydbsubnetgroup").withSubnetIds("subnet-70e1975a",
           "subnet-747a5c49");
          DBSubnetGroup response = client.modifyDBSubnetGroup(request);
      • modifyEventSubscription

        public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)

        Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

        You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

        Specified by:
        modifyEventSubscription in interface AmazonRDS
        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 SNS topic specified.
        SNSNoAuthorizationException - You do not have permission to publish to the SNS topic ARN.
        SNSTopicArnNotFoundException - The SNS topic ARN does not exist.
        SubscriptionCategoryNotFoundException - The supplied category does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • To change event notification subscription settings
          This example changes the specified setting for the specified event notification subscription.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyEventSubscriptionRequest request = new ModifyEventSubscriptionRequest().withSubscriptionName("mymysqleventsubscription")
           .withSourceType("db-instance").withEventCategories("deletion", "low storage").withEnabled(true);
          EventSubscription response = client.modifyEventSubscription(request);
      • modifyIntegration

        public ModifyIntegrationResult modifyIntegration(ModifyIntegrationRequest request)

        Modifies a zero-ETL integration with Amazon Redshift.

        Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.

        Specified by:
        modifyIntegration in interface AmazonRDS
        Parameters:
        modifyIntegrationRequest -
        Returns:
        Result of the ModifyIntegration operation returned by the service.
        Throws:
        IntegrationNotFoundException - The specified integration could not be found.
        InvalidIntegrationStateException - The integration is in an invalid state and can't perform the requested operation.
        IntegrationConflictOperationException - A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
        See Also:
        AWS API Documentation
      • modifyOptionGroup

        public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest request)

        Modifies an existing option group.

        Specified by:
        modifyOptionGroup in interface AmazonRDS
        Parameters:
        modifyOptionGroupRequest -
        Returns:
        Result of the ModifyOptionGroup operation returned by the service.
        Throws:
        InvalidOptionGroupStateException - The option group isn't in the available state.
        OptionGroupNotFoundException - The specified option group could not be found.
        See Also:
        AWS API Documentation

        Samples:
        • To modify an option group
          The following example adds an option to an option group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ModifyOptionGroupRequest request = new ModifyOptionGroupRequest().withOptionGroupName("myawsuser-og02")
           .withOptionsToInclude(new OptionConfiguration().withOptionName("MEMCACHED").withDBSecurityGroupMemberships("default"))
           .withApplyImmediately(true);
          OptionGroup response = client.modifyOptionGroup(request);
      • promoteReadReplica

        public DBInstance promoteReadReplica(PromoteReadReplicaRequest request)

        Promotes a read replica DB instance to a standalone DB instance.

        • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.

        • This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

        Specified by:
        promoteReadReplica in interface AmazonRDS
        Parameters:
        promoteReadReplicaRequest -
        Returns:
        Result of the PromoteReadReplica operation returned by the service.
        Throws:
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        See Also:
        AWS API Documentation

        Samples:
        • To promote a read replica
          This example promotes the specified read replica and sets its backup retention period and preferred backup window.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          PromoteReadReplicaRequest request = new PromoteReadReplicaRequest().withDBInstanceIdentifier("mydbreadreplica").withBackupRetentionPeriod(1)
           .withPreferredBackupWindow("03:30-04:00");
          DBInstance response = client.promoteReadReplica(request);
      • purchaseReservedDBInstancesOffering

        public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest request)

        Purchases a reserved DB instance offering.

        Specified by:
        purchaseReservedDBInstancesOffering in interface AmazonRDS
        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.
        See Also:
        AWS API Documentation

        Samples:
        • To purchase a reserved DB instance offering
          This example purchases a reserved DB instance offering that matches the specified settings.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          PurchaseReservedDBInstancesOfferingRequest request = new PurchaseReservedDBInstancesOfferingRequest().withReservedDBInstancesOfferingId(
           "fb29428a-646d-4390-850e-5fe89926e727").withReservedDBInstanceId("myreservationid");
          ReservedDBInstance response = client.purchaseReservedDBInstancesOffering(request);
      • rebootDBCluster

        public DBCluster rebootDBCluster(RebootDBClusterRequest request)

        You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

        Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

        Use this operation only for a non-Aurora Multi-AZ DB cluster.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        rebootDBCluster in interface AmazonRDS
        Parameters:
        rebootDBClusterRequest -
        Returns:
        Result of the RebootDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        See Also:
        AWS API Documentation
      • rebootDBInstance

        public DBInstance rebootDBInstance(RebootDBInstanceRequest request)

        You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

        Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

        For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

        This command doesn't apply to RDS Custom.

        If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

        Specified by:
        rebootDBInstance in interface AmazonRDS
        Parameters:
        rebootDBInstanceRequest -
        Returns:
        Result of the RebootDBInstance operation returned by the service.
        Throws:
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        See Also:
        AWS API Documentation

        Samples:
        • To reboot a DB instance
          This example reboots the specified DB instance without forcing a failover.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RebootDBInstanceRequest request = new RebootDBInstanceRequest().withDBInstanceIdentifier("mymysqlinstance").withForceFailover(false);
          DBInstance response = client.rebootDBInstance(request);
      • removeFromGlobalCluster

        public GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest request)

        Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.

        This operation only applies to Aurora DB clusters.

        Specified by:
        removeFromGlobalCluster in interface AmazonRDS
        Parameters:
        removeFromGlobalClusterRequest -
        Returns:
        Result of the RemoveFromGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        See Also:
        AWS API Documentation
      • removeSourceIdentifierFromSubscription

        public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)

        Removes a source identifier from an existing RDS event notification subscription.

        Specified by:
        removeSourceIdentifierFromSubscription in interface AmazonRDS
        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.
        See Also:
        AWS API Documentation

        Samples:
        • To remove a source identifier from a DB event subscription
          This example removes the specified source identifier from the specified DB event subscription.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RemoveSourceIdentifierFromSubscriptionRequest request = new RemoveSourceIdentifierFromSubscriptionRequest().withSubscriptionName("myeventsubscription")
           .withSourceIdentifier("mymysqlinstance");
          EventSubscription response = client.removeSourceIdentifierFromSubscription(request);
      • resetDBClusterParameterGroup

        public ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)

        Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

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

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        resetDBClusterParameterGroup in interface AmazonRDS
        Parameters:
        resetDBClusterParameterGroupRequest -
        Returns:
        Result of the ResetDBClusterParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To reset the values of a DB cluster parameter group
          This example resets all parameters for the specified DB cluster parameter group to their default values.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ResetDBClusterParameterGroupRequest request = new ResetDBClusterParameterGroupRequest().withDBClusterParameterGroupName("mydbclusterparametergroup")
           .withResetAllParameters(true);
          ResetDBClusterParameterGroupResult response = client.resetDBClusterParameterGroup(request);
      • resetDBParameterGroup

        public ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest request)

        Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

        Specified by:
        resetDBParameterGroup in interface AmazonRDS
        Parameters:
        resetDBParameterGroupRequest -
        Returns:
        Result of the ResetDBParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

        Samples:
        • To reset the values of a DB parameter group
          This example resets all parameters for the specified DB parameter group to their default values.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          ResetDBParameterGroupRequest request = new ResetDBParameterGroupRequest().withDBParameterGroupName("mydbparametergroup").withResetAllParameters(true);
          ResetDBParameterGroupResult response = client.resetDBParameterGroup(request);
      • restoreDBClusterFromS3

        public DBCluster restoreDBClusterFromS3(RestoreDBClusterFromS3Request request)

        Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.

        This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 operation has completed and the DB cluster is available.

        For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

        Specified by:
        restoreDBClusterFromS3 in interface AmazonRDS
        Parameters:
        restoreDBClusterFromS3Request -
        Returns:
        Result of the RestoreDBClusterFromS3 operation returned by the service.
        Throws:
        DBClusterAlreadyExistsException - The user already has a DB cluster with the given identifier.
        DBClusterQuotaExceededException - The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        InvalidVPCNetworkStateException - The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBSubnetGroupStateException - The DB subnet group cannot be deleted because it's in use.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        InvalidS3BucketException - The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
        DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        DomainNotFoundException - Domain doesn't refer to an existing Active Directory domain.
        InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
        StorageTypeNotSupportedException - The specified StorageType can't be associated with the DB instance.
        See Also:
        AWS API Documentation
      • restoreDBClusterFromSnapshot

        public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)

        Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

        The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

        This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        restoreDBClusterFromSnapshot in interface AmazonRDS
        Parameters:
        restoreDBClusterFromSnapshotRequest -
        Returns:
        Result of the RestoreDBClusterFromSnapshot operation returned by the service.
        Throws:
        DBClusterAlreadyExistsException - The user already has a DB cluster with the given identifier.
        DBClusterQuotaExceededException - The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        InsufficientDBClusterCapacityException - The DB cluster doesn't have enough capacity for the current operation.
        InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
        InvalidDBSnapshotStateException - The state of the DB snapshot doesn't allow deletion.
        InvalidDBClusterSnapshotStateException - The supplied value isn't a valid DB cluster snapshot state.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        InvalidVPCNetworkStateException - The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
        DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
        InvalidRestoreException - Cannot restore from VPC backup to non-VPC DB instance.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        OptionGroupNotFoundException - The specified option group could not be found.
        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        DomainNotFoundException - Domain doesn't refer to an existing Active Directory domain.
        DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        InsufficientDBInstanceCapacityException - The specified DB instance class isn't available in the specified Availability Zone.
        See Also:
        AWS API Documentation

        Samples:
        • To restore an Amazon Aurora DB cluster from a DB cluster snapshot
          The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RestoreDBClusterFromSnapshotRequest request = new RestoreDBClusterFromSnapshotRequest().withDBClusterIdentifier("restored-cluster1")
           .withSnapshotIdentifier("sample-cluster-snapshot1").withEngine("aurora");
          DBCluster response = client.restoreDBClusterFromSnapshot(request);
      • restoreDBClusterToPointInTime

        public DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)

        Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

        For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime operation has completed and the DB cluster is available.

        For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

        For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

        Specified by:
        restoreDBClusterToPointInTime in interface AmazonRDS
        Parameters:
        restoreDBClusterToPointInTimeRequest -
        Returns:
        Result of the RestoreDBClusterToPointInTime operation returned by the service.
        Throws:
        DBClusterAlreadyExistsException - The user already has a DB cluster with the given identifier.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        DBClusterQuotaExceededException - The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        InsufficientDBClusterCapacityException - The DB cluster doesn't have enough capacity for the current operation.
        InsufficientStorageClusterCapacityException - There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
        InvalidDBClusterSnapshotStateException - The supplied value isn't a valid DB cluster snapshot state.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        InvalidDBSnapshotStateException - The state of the DB snapshot doesn't allow deletion.
        InvalidRestoreException - Cannot restore from VPC backup to non-VPC DB instance.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        InvalidVPCNetworkStateException - The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        OptionGroupNotFoundException - The specified option group could not be found.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        DomainNotFoundException - Domain doesn't refer to an existing Active Directory domain.
        DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
        DBClusterAutomatedBackupNotFoundException - No automated backup for this DB cluster was found.
        InsufficientDBInstanceCapacityException - The specified DB instance class isn't available in the specified Availability Zone.
        See Also:
        AWS API Documentation

        Samples:
        • To restore a DB cluster to a point in time.
          The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RestoreDBClusterToPointInTimeRequest request = new RestoreDBClusterToPointInTimeRequest().withDBClusterIdentifier("sample-restored-cluster1")
           .withSourceDBClusterIdentifier("sample-cluster1").withRestoreToTime(new Date("2016-09-13T18:45:00Z"));
          DBCluster response = client.restoreDBClusterToPointInTime(request);
      • restoreDBInstanceFromDBSnapshot

        public DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest request)

        Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

        If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.

        If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

        This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

        Specified by:
        restoreDBInstanceFromDBSnapshot in interface AmazonRDS
        Parameters:
        restoreDBInstanceFromDBSnapshotRequest -
        Returns:
        Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
        Throws:
        DBInstanceAlreadyExistsException - The user already has a DB instance with the given identifier.
        DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
        InstanceQuotaExceededException - The request would result in the user exceeding the allowed number of DB instances.
        InsufficientDBInstanceCapacityException - The specified DB instance class isn't available in the specified Availability Zone.
        InvalidDBSnapshotStateException - The state of the DB snapshot doesn't allow deletion.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        InvalidVPCNetworkStateException - The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
        InvalidRestoreException - Cannot restore from VPC backup to non-VPC DB instance.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        ProvisionedIopsNotAvailableInAZException - Provisioned IOPS not available in the specified Availability Zone.
        OptionGroupNotFoundException - The specified option group could not be found.
        StorageTypeNotSupportedException - The specified StorageType can't be associated with the DB instance.
        AuthorizationNotFoundException - The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

        Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        DBSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing DB security group.
        DomainNotFoundException - Domain doesn't refer to an existing Active Directory domain.
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        BackupPolicyNotFoundException
        NetworkTypeNotSupportedException - The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
        CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.
        TenantDatabaseQuotaExceededException - You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
        See Also:
        AWS API Documentation

        Samples:
        • To restore a DB instance from a DB snapshot.
          The following example restores a DB instance from a DB snapshot.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RestoreDBInstanceFromDBSnapshotRequest request = new RestoreDBInstanceFromDBSnapshotRequest().withDBInstanceIdentifier("mysqldb-restored")
           .withDBSnapshotIdentifier("rds:mysqldb-2014年04月22日-08-15");
          DBInstance response = client.restoreDBInstanceFromDBSnapshot(request);
      • restoreDBInstanceToPointInTime

        public DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest request)

        Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

        The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

        This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

        Specified by:
        restoreDBInstanceToPointInTime in interface AmazonRDS
        Parameters:
        restoreDBInstanceToPointInTimeRequest -
        Returns:
        Result of the RestoreDBInstanceToPointInTime operation returned by the service.
        Throws:
        DBInstanceAlreadyExistsException - The user already has a DB instance with the given identifier.
        DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB instance.
        InstanceQuotaExceededException - The request would result in the user exceeding the allowed number of DB instances.
        InsufficientDBInstanceCapacityException - The specified DB instance class isn't available in the specified Availability Zone.
        InvalidDBInstanceStateException - The DB instance isn't in a valid state.
        PointInTimeRestoreNotEnabledException - SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
        StorageQuotaExceededException - The request would result in the user exceeding the allowed amount of storage available across all DB instances.
        InvalidVPCNetworkStateException - The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
        InvalidRestoreException - Cannot restore from VPC backup to non-VPC DB instance.
        DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing DB subnet group.
        DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
        InvalidSubnetException - The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
        ProvisionedIopsNotAvailableInAZException - Provisioned IOPS not available in the specified Availability Zone.
        OptionGroupNotFoundException - The specified option group could not be found.
        StorageTypeNotSupportedException - The specified StorageType can't be associated with the DB instance.
        AuthorizationNotFoundException - The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

        Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

        KMSKeyNotAccessibleException - An error occurred accessing an Amazon Web Services KMS key.
        DBSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing DB security group.
        DomainNotFoundException - Domain doesn't refer to an existing Active Directory domain.
        BackupPolicyNotFoundException
        DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing DB parameter group.
        DBInstanceAutomatedBackupNotFoundException - No automated backup for this DB instance was found.
        NetworkTypeNotSupportedException - The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.
        TenantDatabaseQuotaExceededException - You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
        CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.
        See Also:
        AWS API Documentation

        Samples:
        • To restore a DB instance to a point in time.
          The following example restores a DB instance to a new DB instance at a point in time from the source DB instance.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RestoreDBInstanceToPointInTimeRequest request = new RestoreDBInstanceToPointInTimeRequest().withSourceDBInstanceIdentifier("mysql-sample")
           .withTargetDBInstanceIdentifier("mysql-sample-restored").withRestoreTime(new Date("2016-09-13T18:45:00Z"));
          DBInstance response = client.restoreDBInstanceToPointInTime(request);
      • revokeDBSecurityGroupIngress

        public DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest request)

        Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

        EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

        Specified by:
        revokeDBSecurityGroupIngress in interface AmazonRDS
        Parameters:
        revokeDBSecurityGroupIngressRequest -
        Returns:
        Result of the RevokeDBSecurityGroupIngress operation returned by the service.
        Throws:
        DBSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing DB security group.
        AuthorizationNotFoundException - The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

        Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

        InvalidDBSecurityGroupStateException - The state of the DB security group doesn't allow deletion.
        See Also:
        AWS API Documentation

        Samples:
        • To revoke ingress for a DB security group
          This example revokes ingress for the specified CIDR block associated with the specified DB security group.
          AmazonRDS client = AmazonRDSClientBuilder.standard().build();
          RevokeDBSecurityGroupIngressRequest request = new RevokeDBSecurityGroupIngressRequest().withDBSecurityGroupName("mydbsecuritygroup").withCIDRIP(
           "203.0.113.5/32");
          DBSecurityGroup response = client.revokeDBSecurityGroupIngress(request);
      • switchoverGlobalCluster

        public GlobalCluster switchoverGlobalCluster(SwitchoverGlobalClusterRequest request)

        Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."

        Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.

        This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.

        Specified by:
        switchoverGlobalCluster in interface AmazonRDS
        Parameters:
        switchoverGlobalClusterRequest -
        Returns:
        Result of the SwitchoverGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        InvalidDBClusterStateException - The requested operation can't be performed while the cluster is in this state.
        DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing DB cluster.
        See Also:
        AWS API Documentation
      • getCachedResponseMetadata

        public 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 the request.

        Specified by:
        getCachedResponseMetadata in interface AmazonRDS
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.
      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonRDS
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /