com.amazonaws.services.rds.AmazonRDS Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.rds;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.rds.model.*;
import com.amazonaws.services.rds.waiters.AmazonRDSWaiters;
/**
* Interface for accessing Amazon RDS.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.rds.AbstractAmazonRDS} instead.
*
*
* Amazon Relational Database Service
*
*
*
* Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a
* relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational
* database and manages common database administration tasks, freeing up developers to focus on what makes their
* applications and businesses unique.
*
*
* Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or
* Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today
* with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your
* database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your
* 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
*
*
* -
*
* For the alphabetical list of API actions, see API Actions.
*
*
* -
*
* For the alphabetical list of data types, see Data Types.
*
*
* -
*
* For a list of common query parameters, see Common Parameters.
*
*
* -
*
* For descriptions of the error codes, see Common Errors.
*
*
*
*
* Amazon RDS User Guide
*
*
* -
*
* For a summary of the Amazon RDS interfaces, see Available RDS
* Interfaces.
*
*
* -
*
* For more information about how to use the Query API, see Using the Query API.
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonRDS {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "rds";
/**
* Overrides the default endpoint for this client ("rds.amazonaws.com"). Callers can use this method to control
* which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "rds.amazonaws.com") or a full URL, including the protocol (ex:
* "rds.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "rds.amazonaws.com") or a full URL, including the protocol (ex: "rds.amazonaws.com") of
* the region specific AWS endpoint this client will communicate with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonRDS#setEndpoint(String)}, sets the regional endpoint for this client's service
* calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information,
* see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User
* Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param addRoleToDBClusterRequest
* @return Result of the AddRoleToDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBClusterRoleAlreadyExistsException
* The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DBClusterRoleQuotaExceededException
* You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
* @sample AmazonRDS.AddRoleToDBCluster
* @see AWS API
* Documentation
*/
AddRoleToDBClusterResult addRoleToDBCluster(AddRoleToDBClusterRequest addRoleToDBClusterRequest);
/**
*
* Associates an AWS Identity and Access Management (IAM) role with a DB instance.
*
*
*
* To add a role to a DB instance, the status of the DB instance must be available.
*
*
*
* @param addRoleToDBInstanceRequest
* @return Result of the AddRoleToDBInstance operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBInstanceRoleAlreadyExistsException
* The specified RoleArn or FeatureName value is already associated with the DB
* instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBInstanceRoleQuotaExceededException
* You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because
* the quota has been reached.
* @sample AmazonRDS.AddRoleToDBInstance
* @see AWS API
* Documentation
*/
AddRoleToDBInstanceResult addRoleToDBInstance(AddRoleToDBInstanceRequest addRoleToDBInstanceRequest);
/**
*
* Adds a source identifier to an existing RDS event notification subscription.
*
*
* @param addSourceIdentifierToSubscriptionRequest
* @return Result of the AddSourceIdentifierToSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @sample AmazonRDS.AddSourceIdentifierToSubscription
* @see AWS API Documentation
*/
EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest);
/**
*
* Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track
* cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
*
*
* For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS
* Resources.
*
*
* @param addTagsToResourceRequest
* @return Result of the AddTagsToResource operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @sample AmazonRDS.AddTagsToResource
* @see AWS API
* Documentation
*/
AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest);
/**
*
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*
*
* @param applyPendingMaintenanceActionRequest
* @return Result of the ApplyPendingMaintenanceAction operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.ApplyPendingMaintenanceAction
* @see AWS API Documentation
*/
ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest);
/**
*
* 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 AWS 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.
*
*
* @param authorizeDBSecurityGroupIngressRequest
* @return Result of the AuthorizeDBSecurityGroupIngress operation returned by the service.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InvalidDBSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws AuthorizationAlreadyExistsException
* The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB
* security group.
* @throws AuthorizationQuotaExceededException
* The DB security group authorization quota has been reached.
* @sample AmazonRDS.AuthorizeDBSecurityGroupIngress
* @see AWS API Documentation
*/
DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest);
/**
*
* Backtracks a DB cluster to a specific time, without creating a new DB cluster.
*
*
* For more information on backtracking, see
* Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora MySQL DB clusters.
*
*
*
* @param backtrackDBClusterRequest
* @return Result of the BacktrackDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @sample AmazonRDS.BacktrackDBCluster
* @see AWS API
* Documentation
*/
BacktrackDBClusterResult backtrackDBCluster(BacktrackDBClusterRequest backtrackDBClusterRequest);
/**
*
* Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been
* written to the S3 bucket isn't removed.
*
*
* @param cancelExportTaskRequest
* @return Result of the CancelExportTask operation returned by the service.
* @throws ExportTaskNotFoundException
* The export task doesn't exist.
* @throws InvalidExportTaskStateException
* You can't cancel an export task that has completed.
* @sample AmazonRDS.CancelExportTask
* @see AWS API
* Documentation
*/
CancelExportTaskResult cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest);
/**
*
* Copies the specified DB cluster parameter group.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param copyDBClusterParameterGroupRequest
* @return Result of the CopyDBClusterParameterGroup operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DBParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @throws DBParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @sample AmazonRDS.CopyDBClusterParameterGroup
* @see AWS API Documentation
*/
DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest);
/**
*
* Copies a snapshot of a DB cluster.
*
*
* To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
* SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster
* snapshot.
*
*
* You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you
* call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster
* snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
* following values:
*
*
* -
*
* KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
* copy of the DB cluster snapshot in the destination AWS Region.
*
*
* -
*
* PreSignedUrl - A URL that contains a Signature Version 4 signed request for the
* CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is
* copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action
* that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
*
*
* The pre-signed URL request must contain the following parameter values:
*
*
* -
*
* KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
* in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action
* that is called in the destination AWS Region, and the action contained in the pre-signed URL.
*
*
* -
*
* DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
* snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
* Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
* SourceDBClusterSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests:
* Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*
*
* If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or
* --source-region for the AWS CLI) instead of specifying PreSignedUrl manually.
* Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation
* that can be executed in the source AWS Region.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in
* the destination AWS Region.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
* snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value
* as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
*
*
*
*
* To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
* TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
*
*
* For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a
* Snapshot in the Amazon Aurora User Guide.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param copyDBClusterSnapshotRequest
* @return Result of the CopyDBClusterSnapshot operation returned by the service.
* @throws DBClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @sample AmazonRDS.CopyDBClusterSnapshot
* @see AWS API
* Documentation
*/
DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest);
/**
*
* Copies the specified DB parameter group.
*
*
* @param copyDBParameterGroupRequest
* @return Result of the CopyDBParameterGroup operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DBParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @throws DBParameterGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB parameter groups.
* @sample AmazonRDS.CopyDBParameterGroup
* @see AWS API
* Documentation
*/
DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest);
/**
*
* Copies the specified DB snapshot. The source DB snapshot must be in the available state.
*
*
* You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the
* CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.
*
*
* For more information about copying snapshots, see Copying
* a DB Snapshot in the Amazon RDS User Guide.
*
*
* @param copyDBSnapshotRequest
* @return Result of the CopyDBSnapshot operation returned by the service.
* @throws DBSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InvalidDBSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @sample AmazonRDS.CopyDBSnapshot
* @see AWS API
* Documentation
*/
DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest);
/**
*
* Copies the specified option group.
*
*
* @param copyOptionGroupRequest
* @return Result of the CopyOptionGroup operation returned by the service.
* @throws OptionGroupAlreadyExistsException
* The option group you are trying to create already exists.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws OptionGroupQuotaExceededException
* The quota of 20 option groups was exceeded for this AWS account.
* @sample AmazonRDS.CopyOptionGroup
* @see AWS API
* Documentation
*/
OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest);
/**
*
* Creates a custom Availability Zone (AZ).
*
*
* A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
*
*
* For more information about RDS on VMware, see the RDS on VMware
* User Guide.
*
*
* @param createCustomAvailabilityZoneRequest
* @return Result of the CreateCustomAvailabilityZone operation returned by the service.
* @throws CustomAvailabilityZoneAlreadyExistsException
* CustomAvailabilityZoneName is already used by an existing custom Availability Zone.
* @throws CustomAvailabilityZoneQuotaExceededException
* You have exceeded the maximum number of custom Availability Zones.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @sample AmazonRDS.CreateCustomAvailabilityZone
* @see AWS API Documentation
*/
CustomAvailabilityZone createCustomAvailabilityZone(CreateCustomAvailabilityZoneRequest createCustomAvailabilityZoneRequest);
/**
*
* Creates a new Amazon Aurora DB cluster.
*
*
* You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of
* another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified
* by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl
* parameter.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param createDBClusterRequest
* @return Result of the CreateDBCluster operation returned by the service.
* @throws DBClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws 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.
* @throws DBClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @sample AmazonRDS.CreateDBCluster
* @see AWS API
* Documentation
*/
DBCluster createDBCluster(CreateDBClusterRequest createDBClusterRequest);
/**
*
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param createDBClusterEndpointRequest
* @return Result of the CreateDBClusterEndpoint operation returned by the service.
* @throws DBClusterEndpointQuotaExceededException
* The cluster already has the maximum number of custom endpoints.
* @throws DBClusterEndpointAlreadyExistsException
* The specified custom endpoint can't be created because it already exists.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.CreateDBClusterEndpoint
* @see AWS
* API Documentation
*/
CreateDBClusterEndpointResult createDBClusterEndpoint(CreateDBClusterEndpointRequest createDBClusterEndpointRequest);
/**
*
* Creates a new DB cluster parameter group.
*
*
* Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
*
*
* A DB cluster parameter group is initially created with the default parameters for the database engine used by
* instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after
* creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group,
* you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB
* cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without
* failover for the new DB cluster parameter group and associated settings to take effect.
*
*
*
* After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
* cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully
* complete the create action before the DB cluster parameter group is used as the default for a new DB cluster.
* This is especially important for parameters that are critical when creating the default database for a DB
* cluster, such as the character set for the default database defined by the character_set_database
* parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
* action 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.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param createDBClusterParameterGroupRequest
* @return 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.
* @throws DBParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @sample AmazonRDS.CreateDBClusterParameterGroup
* @see AWS API Documentation
*/
DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest);
/**
*
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param createDBClusterSnapshotRequest
* @return Result of the CreateDBClusterSnapshot operation returned by the service.
* @throws DBClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @sample AmazonRDS.CreateDBClusterSnapshot
* @see AWS
* API Documentation
*/
DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest);
/**
*
* Creates a new DB instance.
*
*
* @param createDBInstanceRequest
* @return Result of the CreateDBInstance operation returned by the service.
* @throws DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAZException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws BackupPolicyNotFoundException
* @sample AmazonRDS.CreateDBInstance
* @see AWS API
* Documentation
*/
DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest);
/**
*
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read
* replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas
* in the Amazon RDS User Guide.
*
*
* Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance
* for an Aurora DB cluster.
*
*
* All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB
* security groups and DB parameter groups) are inherited from the source DB instance, except as specified.
*
*
*
* Your source DB instance must have backup retention enabled.
*
*
*
* @param createDBInstanceReadReplicaRequest
* @return Result of the CreateDBInstanceReadReplica operation returned by the service.
* @throws DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAZException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DBSubnetGroupNotAllowedException
* The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the
* source instance.
* @throws InvalidDBSubnetGroupException
* The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the
* same source instance.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @sample AmazonRDS.CreateDBInstanceReadReplica
* @see AWS API Documentation
*/
DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest);
/**
*
* Creates a new DB parameter group.
*
*
* A DB parameter group is initially created with the default parameters for the database engine used by the DB
* instance. To provide custom values for any of the parameters, you must modify the group after creating it using
* ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB
* instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance,
* you need to reboot the DB instance without failover for the new DB parameter group and associated settings to
* take effect.
*
*
*
* After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
* that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the
* create action before the parameter group is used as the default for a new DB instance. This is especially
* important for parameters that are critical when creating the default database for a DB instance, such as the
* character set for the default database defined by the character_set_database parameter. You can use
* the Parameter Groups option of the Amazon RDS console or
* the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*
*
*
* @param createDBParameterGroupRequest
* @return 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.
* @throws DBParameterGroupAlreadyExistsException
* A DB parameter group with the same name exists.
* @sample AmazonRDS.CreateDBParameterGroup
* @see AWS API
* Documentation
*/
DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest);
/**
*
* Creates a new DB proxy.
*
*
* @param createDBProxyRequest
* @return Result of the CreateDBProxy 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.
* @throws DBProxyAlreadyExistsException
* The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS
* Region.
* @throws DBProxyQuotaExceededException
* Your AWS account already has the maximum number of proxies in the specified AWS Region.
* @sample AmazonRDS.CreateDBProxy
* @see AWS API
* Documentation
*/
CreateDBProxyResult createDBProxy(CreateDBProxyRequest createDBProxyRequest);
/**
*
* Creates a new DB security group. DB security groups control access to a DB instance.
*
*
*
* A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
*
*
*
* @param createDBSecurityGroupRequest
* @return Result of the CreateDBSecurityGroup operation returned by the service.
* @throws DBSecurityGroupAlreadyExistsException
* A DB security group with the name specified in DBSecurityGroupName already exists.
* @throws DBSecurityGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB security groups.
* @throws DBSecurityGroupNotSupportedException
* A DB security group isn't allowed for this action.
* @sample AmazonRDS.CreateDBSecurityGroup
* @see AWS API
* Documentation
*/
DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest);
/**
*
* Creates a snapshot of a DB instance. The source DB instance must be in the available or
* storage-optimizationstate.
*
*
* @param createDBSnapshotRequest
* @return Result of the CreateDBSnapshot operation returned by the service.
* @throws DBSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @sample AmazonRDS.CreateDBSnapshot
* @see AWS API
* Documentation
*/
DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest);
/**
*
* Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS
* Region.
*
*
* @param createDBSubnetGroupRequest
* @return Result of the CreateDBSubnetGroup operation returned by the service.
* @throws DBSubnetGroupAlreadyExistsException
* DBSubnetGroupName is already used by an existing DB subnet group.
* @throws DBSubnetGroupQuotaExceededException
* The request would result in the user exceeding the allowed number of DB subnet groups.
* @throws DBSubnetQuotaExceededException
* The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @sample AmazonRDS.CreateDBSubnetGroup
* @see AWS API
* Documentation
*/
DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest);
/**
*
* Creates an RDS event notification subscription. This action 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 SourceIdentifier = myDBInstance1, you are notified of all
* the db-instance events for the specified source. If you specify a SourceType but do not
* specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS
* sources. If you don't specify either the SourceType or the SourceIdentifier, you are notified of
* events generated from all RDS sources belonging to your customer account.
*
*
*
* RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event
* notifications aren't sent for the topic.
*
*
*
* @param createEventSubscriptionRequest
* @return Result of the CreateEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionAlreadyExistException
* The supplied subscription name already exists.
* @throws SNSInvalidTopicException
* SNS has responded that there is a problem with the SND topic specified.
* @throws SNSNoAuthorizationException
* You do not have permission to publish to the SNS topic ARN.
* @throws SNSTopicArnNotFoundException
* The SNS topic ARN does not exist.
* @throws SubscriptionCategoryNotFoundException
* The supplied category does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @sample AmazonRDS.CreateEventSubscription
* @see AWS
* API Documentation
*/
EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest);
/**
*
* Creates an Aurora global database spread across multiple AWS 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 add a primary cluster and a secondary cluster
* to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the
* primary cluster of the global database.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param createGlobalClusterRequest
* @return Result of the CreateGlobalCluster operation returned by the service.
* @throws GlobalClusterAlreadyExistsException
* @throws GlobalClusterQuotaExceededException
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @sample AmazonRDS.CreateGlobalCluster
* @see AWS API
* Documentation
*/
GlobalCluster createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest);
/**
*
* Creates a new option group. You can create up to 20 option groups.
*
*
* @param createOptionGroupRequest
* @return Result of the CreateOptionGroup operation returned by the service.
* @throws OptionGroupAlreadyExistsException
* The option group you are trying to create already exists.
* @throws OptionGroupQuotaExceededException
* The quota of 20 option groups was exceeded for this AWS account.
* @sample AmazonRDS.CreateOptionGroup
* @see AWS API
* Documentation
*/
OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest);
/**
*
* Deletes a custom Availability Zone (AZ).
*
*
* A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
*
*
* For more information about RDS on VMware, see the RDS on VMware
* User Guide.
*
*
* @param deleteCustomAvailabilityZoneRequest
* @return Result of the DeleteCustomAvailabilityZone operation returned by the service.
* @throws CustomAvailabilityZoneNotFoundException
* CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @sample AmazonRDS.DeleteCustomAvailabilityZone
* @see AWS API Documentation
*/
CustomAvailabilityZone deleteCustomAvailabilityZone(DeleteCustomAvailabilityZoneRequest deleteCustomAvailabilityZoneRequest);
/**
*
* 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.
*
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param deleteDBClusterRequest
* @return Result of the DeleteDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DBClusterSnapshotAlreadyExistsException
* The user already has a DB cluster snapshot with the given identifier.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @sample AmazonRDS.DeleteDBCluster
* @see AWS API
* Documentation
*/
DBCluster deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest);
/**
*
* Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param deleteDBClusterEndpointRequest
* @return Result of the DeleteDBClusterEndpoint operation returned by the service.
* @throws InvalidDBClusterEndpointStateException
* The requested operation can't be performed on the endpoint while the endpoint is in this state.
* @throws DBClusterEndpointNotFoundException
* The specified custom endpoint doesn't exist.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @sample AmazonRDS.DeleteDBClusterEndpoint
* @see AWS
* API Documentation
*/
DeleteDBClusterEndpointResult deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest deleteDBClusterEndpointRequest);
/**
*
* 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.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param deleteDBClusterParameterGroupRequest
* @return 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.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.DeleteDBClusterParameterGroup
* @see AWS API Documentation
*/
DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest);
/**
*
* 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.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param deleteDBClusterSnapshotRequest
* @return Result of the DeleteDBClusterSnapshot operation returned by the service.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @sample AmazonRDS.DeleteDBClusterSnapshot
* @see AWS
* API Documentation
*/
DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest);
/**
*
* The DeleteDBInstance action 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. Manual DB snapshots of the DB instance to
* be deleted by DeleteDBInstance are not deleted.
*
*
* If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB
* snapshot is created. The API action DescribeDBInstance is used to monitor the status of this
* operation. The action can't be canceled or reverted once submitted.
*
*
* 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 call the PromoteReadReplicaDBCluster API action to
* promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the
* DeleteDBInstance API action to delete the final instance in the DB cluster.
*
*
* @param deleteDBInstanceRequest
* @return Result of the DeleteDBInstance operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws 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.
* @sample AmazonRDS.DeleteDBInstance
* @see AWS API
* Documentation
*/
DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest);
/**
*
* Deletes automated backups based on the source instance's DbiResourceId value or the restorable
* instance's resource ID.
*
*
* @param deleteDBInstanceAutomatedBackupRequest
* Parameter input for the DeleteDBInstanceAutomatedBackup operation.
* @return Result of the DeleteDBInstanceAutomatedBackup operation returned by the service.
* @throws InvalidDBInstanceAutomatedBackupStateException
* The automated backup is in an invalid state. For example, this automated backup is associated with an
* active instance.
* @throws DBInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @sample AmazonRDS.DeleteDBInstanceAutomatedBackup
* @see AWS API Documentation
*/
DBInstanceAutomatedBackup deleteDBInstanceAutomatedBackup(DeleteDBInstanceAutomatedBackupRequest deleteDBInstanceAutomatedBackupRequest);
/**
*
* Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB
* instances.
*
*
* @param deleteDBParameterGroupRequest
* @return 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.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.DeleteDBParameterGroup
* @see AWS API
* Documentation
*/
DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest);
/**
*
* Deletes an existing proxy.
*
*
* @param deleteDBProxyRequest
* @return Result of the DeleteDBProxy operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @sample AmazonRDS.DeleteDBProxy
* @see AWS API
* Documentation
*/
DeleteDBProxyResult deleteDBProxy(DeleteDBProxyRequest deleteDBProxyRequest);
/**
*
* Deletes a DB security group.
*
*
*
* The specified DB security group must not be associated with any DB instances.
*
*
*
* @param deleteDBSecurityGroupRequest
* @return Result of the DeleteDBSecurityGroup operation returned by the service.
* @throws InvalidDBSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @sample AmazonRDS.DeleteDBSecurityGroup
* @see AWS API
* Documentation
*/
DeleteDBSecurityGroupResult deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest);
/**
*
* 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.
*
*
*
* @param deleteDBSnapshotRequest
* @return Result of the DeleteDBSnapshot operation returned by the service.
* @throws InvalidDBSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @sample AmazonRDS.DeleteDBSnapshot
* @see AWS API
* Documentation
*/
DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest);
/**
*
* Deletes a DB subnet group.
*
*
*
* The specified database subnet group must not be associated with any DB instances.
*
*
*
* @param deleteDBSubnetGroupRequest
* @return Result of the DeleteDBSubnetGroup operation returned by the service.
* @throws InvalidDBSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidDBSubnetStateException
* The DB subnet isn't in the available state.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @sample AmazonRDS.DeleteDBSubnetGroup
* @see AWS API
* Documentation
*/
DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest);
/**
*
* Deletes an RDS event notification subscription.
*
*
* @param deleteEventSubscriptionRequest
* @return Result of the DeleteEventSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws InvalidEventSubscriptionStateException
* This error can occur if someone else is modifying a subscription. You should retry the action.
* @sample AmazonRDS.DeleteEventSubscription
* @see AWS
* API Documentation
*/
EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest);
/**
*
* Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed
* first.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param deleteGlobalClusterRequest
* @return Result of the DeleteGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @sample AmazonRDS.DeleteGlobalCluster
* @see AWS API
* Documentation
*/
GlobalCluster deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest);
/**
*
* Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as
* Microsoft SQL Server.
*
*
* @param deleteInstallationMediaRequest
* @return Result of the DeleteInstallationMedia operation returned by the service.
* @throws InstallationMediaNotFoundException
* InstallationMediaID doesn't refer to an existing installation medium.
* @sample AmazonRDS.DeleteInstallationMedia
* @see AWS
* API Documentation
*/
DeleteInstallationMediaResult deleteInstallationMedia(DeleteInstallationMediaRequest deleteInstallationMediaRequest);
/**
*
* Deletes an existing option group.
*
*
* @param deleteOptionGroupRequest
* @return Result of the DeleteOptionGroup operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws InvalidOptionGroupStateException
* The option group isn't in the available state.
* @sample AmazonRDS.DeleteOptionGroup
* @see AWS API
* Documentation
*/
DeleteOptionGroupResult deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest);
/**
*
* Remove the association between one or more DBProxyTarget data structures and a
* DBProxyTargetGroup.
*
*
* @param deregisterDBProxyTargetsRequest
* @return Result of the DeregisterDBProxyTargets operation returned by the service.
* @throws DBProxyTargetNotFoundException
* The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your AWS account
* in the specified AWS Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @sample AmazonRDS.DeregisterDBProxyTargets
* @see AWS
* API Documentation
*/
DeregisterDBProxyTargetsResult deregisterDBProxyTargets(DeregisterDBProxyTargetsRequest deregisterDBProxyTargetsRequest);
/**
*
* 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.
*
*
* @param describeAccountAttributesRequest
* @return Result of the DescribeAccountAttributes operation returned by the service.
* @sample AmazonRDS.DescribeAccountAttributes
* @see AWS
* API Documentation
*/
DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest);
/**
* Simplified method form for invoking the DescribeAccountAttributes operation.
*
* @see #describeAccountAttributes(DescribeAccountAttributesRequest)
*/
DescribeAccountAttributesResult describeAccountAttributes();
/**
*
* Lists the set of CA certificates provided by Amazon RDS for this AWS account.
*
*
* @param describeCertificatesRequest
* @return Result of the DescribeCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @sample AmazonRDS.DescribeCertificates
* @see AWS API
* Documentation
*/
DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest);
/**
* Simplified method form for invoking the DescribeCertificates operation.
*
* @see #describeCertificates(DescribeCertificatesRequest)
*/
DescribeCertificatesResult describeCertificates();
/**
*
* Returns information about custom Availability Zones (AZs).
*
*
* A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
*
*
* For more information about RDS on VMware, see the RDS on VMware
* User Guide.
*
*
* @param describeCustomAvailabilityZonesRequest
* @return Result of the DescribeCustomAvailabilityZones operation returned by the service.
* @throws CustomAvailabilityZoneNotFoundException
* CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.
* @sample AmazonRDS.DescribeCustomAvailabilityZones
* @see AWS API Documentation
*/
DescribeCustomAvailabilityZonesResult describeCustomAvailabilityZones(DescribeCustomAvailabilityZonesRequest describeCustomAvailabilityZonesRequest);
/**
*
* Returns information about backtracks for a DB cluster.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora MySQL DB clusters.
*
*
*
* @param describeDBClusterBacktracksRequest
* @return Result of the DescribeDBClusterBacktracks operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBClusterBacktrackNotFoundException
* BacktrackIdentifier doesn't refer to an existing backtrack.
* @sample AmazonRDS.DescribeDBClusterBacktracks
* @see AWS API Documentation
*/
DescribeDBClusterBacktracksResult describeDBClusterBacktracks(DescribeDBClusterBacktracksRequest describeDBClusterBacktracksRequest);
/**
*
* Returns information about endpoints for an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeDBClusterEndpointsRequest
* @return Result of the DescribeDBClusterEndpoints operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @sample AmazonRDS.DescribeDBClusterEndpoints
* @see AWS
* API Documentation
*/
DescribeDBClusterEndpointsResult describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest describeDBClusterEndpointsRequest);
/**
*
* 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.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeDBClusterParameterGroupsRequest
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest);
/**
* Simplified method form for invoking the DescribeDBClusterParameterGroups operation.
*
* @see #describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest)
*/
DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups();
/**
*
* 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.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeDBClusterParametersRequest
* @return Result of the DescribeDBClusterParameters operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.DescribeDBClusterParameters
* @see AWS API Documentation
*/
DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest);
/**
*
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
*
*
* When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the
* restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the
* manual DB cluster snapshot. If all is included in the list of values for the restore
* attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
*
*
* To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual
* DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeDBClusterSnapshotAttributesRequest
* @return Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @sample AmazonRDS.DescribeDBClusterSnapshotAttributes
* @see AWS API Documentation
*/
DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest);
/**
*
* Returns information about DB cluster snapshots. This API action supports pagination.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeDBClusterSnapshotsRequest
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @sample AmazonRDS.DescribeDBClusterSnapshots
* @see AWS
* API Documentation
*/
DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest);
/**
* Simplified method form for invoking the DescribeDBClusterSnapshots operation.
*
* @see #describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)
*/
DescribeDBClusterSnapshotsResult describeDBClusterSnapshots();
/**
*
* Returns information about provisioned Aurora DB clusters. This API supports pagination.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*
*
*
* @param describeDBClustersRequest
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @sample AmazonRDS.DescribeDBClusters
* @see AWS API
* Documentation
*/
DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest);
/**
* Simplified method form for invoking the DescribeDBClusters operation.
*
* @see #describeDBClusters(DescribeDBClustersRequest)
*/
DescribeDBClustersResult describeDBClusters();
/**
*
* Returns a list of the available DB engines.
*
*
* @param describeDBEngineVersionsRequest
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @sample AmazonRDS.DescribeDBEngineVersions
* @see AWS
* API Documentation
*/
DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest);
/**
* Simplified method form for invoking the DescribeDBEngineVersions operation.
*
* @see #describeDBEngineVersions(DescribeDBEngineVersionsRequest)
*/
DescribeDBEngineVersionsResult describeDBEngineVersions();
/**
*
* 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.
*
*
* @param describeDBInstanceAutomatedBackupsRequest
* Parameter input for DescribeDBInstanceAutomatedBackups.
* @return Result of the DescribeDBInstanceAutomatedBackups operation returned by the service.
* @throws DBInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @sample AmazonRDS.DescribeDBInstanceAutomatedBackups
* @see AWS API Documentation
*/
DescribeDBInstanceAutomatedBackupsResult describeDBInstanceAutomatedBackups(
DescribeDBInstanceAutomatedBackupsRequest describeDBInstanceAutomatedBackupsRequest);
/**
*
* Returns information about provisioned RDS instances. This API supports pagination.
*
*
*
* This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*
*
*
* @param describeDBInstancesRequest
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @sample AmazonRDS.DescribeDBInstances
* @see AWS API
* Documentation
*/
DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest);
/**
* Simplified method form for invoking the DescribeDBInstances operation.
*
* @see #describeDBInstances(DescribeDBInstancesRequest)
*/
DescribeDBInstancesResult describeDBInstances();
/**
*
* Returns a list of DB log files for the DB instance.
*
*
* @param describeDBLogFilesRequest
* @return Result of the DescribeDBLogFiles operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @sample AmazonRDS.DescribeDBLogFiles
* @see AWS API
* Documentation
*/
DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest);
/**
*
* Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is
* specified, the list will contain only the description of the specified DB parameter group.
*
*
* @param describeDBParameterGroupsRequest
* @return Result of the DescribeDBParameterGroups operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.DescribeDBParameterGroups
* @see AWS
* API Documentation
*/
DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest);
/**
* Simplified method form for invoking the DescribeDBParameterGroups operation.
*
* @see #describeDBParameterGroups(DescribeDBParameterGroupsRequest)
*/
DescribeDBParameterGroupsResult describeDBParameterGroups();
/**
*
* Returns the detailed parameter list for a particular DB parameter group.
*
*
* @param describeDBParametersRequest
* @return Result of the DescribeDBParameters operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.DescribeDBParameters
* @see AWS API
* Documentation
*/
DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest);
/**
*
* Returns information about DB proxies.
*
*
* @param describeDBProxiesRequest
* @return Result of the DescribeDBProxies operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @sample AmazonRDS.DescribeDBProxies
* @see AWS API
* Documentation
*/
DescribeDBProxiesResult describeDBProxies(DescribeDBProxiesRequest describeDBProxiesRequest);
/**
*
* Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
*
*
* @param describeDBProxyTargetGroupsRequest
* @return Result of the DescribeDBProxyTargetGroups operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @sample AmazonRDS.DescribeDBProxyTargetGroups
* @see AWS API Documentation
*/
DescribeDBProxyTargetGroupsResult describeDBProxyTargetGroups(DescribeDBProxyTargetGroupsRequest describeDBProxyTargetGroupsRequest);
/**
*
* Returns information about DBProxyTarget objects. This API supports pagination.
*
*
* @param describeDBProxyTargetsRequest
* @return Result of the DescribeDBProxyTargets operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetNotFoundException
* The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your AWS account
* in the specified AWS Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @sample AmazonRDS.DescribeDBProxyTargets
* @see AWS API
* Documentation
*/
DescribeDBProxyTargetsResult describeDBProxyTargets(DescribeDBProxyTargetsRequest describeDBProxyTargetsRequest);
/**
*
* Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,
* the list will contain only the descriptions of the specified DB security group.
*
*
* @param describeDBSecurityGroupsRequest
* @return Result of the DescribeDBSecurityGroups operation returned by the service.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @sample AmazonRDS.DescribeDBSecurityGroups
* @see AWS
* API Documentation
*/
DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest);
/**
* Simplified method form for invoking the DescribeDBSecurityGroups operation.
*
* @see #describeDBSecurityGroups(DescribeDBSecurityGroupsRequest)
*/
DescribeDBSecurityGroupsResult describeDBSecurityGroups();
/**
*
* Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
*
*
* When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the
* restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the
* manual DB snapshot. If all is included in the list of values for the restore attribute,
* then the manual DB snapshot is public and can be copied or restored by all AWS accounts.
*
*
* To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB
* snapshot public or private, use the ModifyDBSnapshotAttribute API action.
*
*
* @param describeDBSnapshotAttributesRequest
* @return Result of the DescribeDBSnapshotAttributes operation returned by the service.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @sample AmazonRDS.DescribeDBSnapshotAttributes
* @see AWS API Documentation
*/
DBSnapshotAttributesResult describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest);
/**
* Simplified method form for invoking the DescribeDBSnapshotAttributes operation.
*
* @see #describeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)
*/
DBSnapshotAttributesResult describeDBSnapshotAttributes();
/**
*
* Returns information about DB snapshots. This API action supports pagination.
*
*
* @param describeDBSnapshotsRequest
* @return Result of the DescribeDBSnapshots operation returned by the service.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @sample AmazonRDS.DescribeDBSnapshots
* @see AWS API
* Documentation
*/
DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest);
/**
* Simplified method form for invoking the DescribeDBSnapshots operation.
*
* @see #describeDBSnapshots(DescribeDBSnapshotsRequest)
*/
DescribeDBSnapshotsResult describeDBSnapshots();
/**
*
* 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.
*
*
* @param describeDBSubnetGroupsRequest
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @sample AmazonRDS.DescribeDBSubnetGroups
* @see AWS API
* Documentation
*/
DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest);
/**
* Simplified method form for invoking the DescribeDBSubnetGroups operation.
*
* @see #describeDBSubnetGroups(DescribeDBSubnetGroupsRequest)
*/
DescribeDBSubnetGroupsResult describeDBSubnetGroups();
/**
*
* 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.
*
*
* @param describeEngineDefaultClusterParametersRequest
* @return Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
* @sample AmazonRDS.DescribeEngineDefaultClusterParameters
* @see AWS API Documentation
*/
EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest);
/**
*
* Returns the default engine and system parameter information for the specified database engine.
*
*
* @param describeEngineDefaultParametersRequest
* @return Result of the DescribeEngineDefaultParameters operation returned by the service.
* @sample AmazonRDS.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest);
/**
*
* Displays a list of categories for all event source types, or, if specified, for a specified source type. You can
* see a list of the event categories and source types in Events in the Amazon RDS
* User Guide.
*
*
* @param describeEventCategoriesRequest
* @return Result of the DescribeEventCategories operation returned by the service.
* @sample AmazonRDS.DescribeEventCategories
* @see AWS
* API Documentation
*/
DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest);
/**
* Simplified method form for invoking the DescribeEventCategories operation.
*
* @see #describeEventCategories(DescribeEventCategoriesRequest)
*/
DescribeEventCategoriesResult describeEventCategories();
/**
*
* 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.
*
*
* @param describeEventSubscriptionsRequest
* @return Result of the DescribeEventSubscriptions operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @sample AmazonRDS.DescribeEventSubscriptions
* @see AWS
* API Documentation
*/
DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest);
/**
* Simplified method form for invoking the DescribeEventSubscriptions operation.
*
* @see #describeEventSubscriptions(DescribeEventSubscriptionsRequest)
*/
DescribeEventSubscriptionsResult describeEventSubscriptions();
/**
*
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and
* DB cluster snapshots for the past 14 days. Events specific to a particular DB instances, DB clusters, DB
* parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be obtained by providing
* the name as a parameter.
*
*
*
* By default, the past hour of events are returned.
*
*
*
* @param describeEventsRequest
* @return Result of the DescribeEvents operation returned by the service.
* @sample AmazonRDS.DescribeEvents
* @see AWS API
* Documentation
*/
DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest);
/**
* Simplified method form for invoking the DescribeEvents operation.
*
* @see #describeEvents(DescribeEventsRequest)
*/
DescribeEventsResult describeEvents();
/**
*
* Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
*
*
* @param describeExportTasksRequest
* @return Result of the DescribeExportTasks operation returned by the service.
* @throws ExportTaskNotFoundException
* The export task doesn't exist.
* @sample AmazonRDS.DescribeExportTasks
* @see AWS API
* Documentation
*/
DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest);
/**
*
* Returns information about Aurora global database clusters. This API supports pagination.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param describeGlobalClustersRequest
* @return Result of the DescribeGlobalClusters operation returned by the service.
* @throws GlobalClusterNotFoundException
* @sample AmazonRDS.DescribeGlobalClusters
* @see AWS API
* Documentation
*/
DescribeGlobalClustersResult describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest);
/**
*
* Describes the available installation media for a DB engine that requires an on-premises customer provided
* license, such as Microsoft SQL Server.
*
*
* @param describeInstallationMediaRequest
* @return Result of the DescribeInstallationMedia operation returned by the service.
* @throws InstallationMediaNotFoundException
* InstallationMediaID doesn't refer to an existing installation medium.
* @sample AmazonRDS.DescribeInstallationMedia
* @see AWS
* API Documentation
*/
DescribeInstallationMediaResult describeInstallationMedia(DescribeInstallationMediaRequest describeInstallationMediaRequest);
/**
*
* Describes all available options.
*
*
* @param describeOptionGroupOptionsRequest
* @return Result of the DescribeOptionGroupOptions operation returned by the service.
* @sample AmazonRDS.DescribeOptionGroupOptions
* @see AWS
* API Documentation
*/
DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest);
/**
*
* Describes the available option groups.
*
*
* @param describeOptionGroupsRequest
* @return Result of the DescribeOptionGroups operation returned by the service.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @sample AmazonRDS.DescribeOptionGroups
* @see AWS API
* Documentation
*/
DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest);
/**
* Simplified method form for invoking the DescribeOptionGroups operation.
*
* @see #describeOptionGroups(DescribeOptionGroupsRequest)
*/
DescribeOptionGroupsResult describeOptionGroups();
/**
*
* Returns a list of orderable DB instance options for the specified engine.
*
*
* @param describeOrderableDBInstanceOptionsRequest
* @return Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
* @sample AmazonRDS.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(
DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest);
/**
*
* Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
*
*
* @param describePendingMaintenanceActionsRequest
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @sample AmazonRDS.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest);
/**
* Simplified method form for invoking the DescribePendingMaintenanceActions operation.
*
* @see #describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
*/
DescribePendingMaintenanceActionsResult describePendingMaintenanceActions();
/**
*
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*
*
* @param describeReservedDBInstancesRequest
* @return Result of the DescribeReservedDBInstances operation returned by the service.
* @throws ReservedDBInstanceNotFoundException
* The specified reserved DB Instance not found.
* @sample AmazonRDS.DescribeReservedDBInstances
* @see AWS API Documentation
*/
DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest);
/**
* Simplified method form for invoking the DescribeReservedDBInstances operation.
*
* @see #describeReservedDBInstances(DescribeReservedDBInstancesRequest)
*/
DescribeReservedDBInstancesResult describeReservedDBInstances();
/**
*
* Lists available reserved DB instance offerings.
*
*
* @param describeReservedDBInstancesOfferingsRequest
* @return Result of the DescribeReservedDBInstancesOfferings operation returned by the service.
* @throws ReservedDBInstancesOfferingNotFoundException
* Specified offering does not exist.
* @sample AmazonRDS.DescribeReservedDBInstancesOfferings
* @see AWS API Documentation
*/
DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(
DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest);
/**
* Simplified method form for invoking the DescribeReservedDBInstancesOfferings operation.
*
* @see #describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest)
*/
DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings();
/**
*
* Returns a list of the source AWS Regions where the current AWS Region can create a read replica or copy a DB
* snapshot from. This API action supports pagination.
*
*
* @param describeSourceRegionsRequest
* @return Result of the DescribeSourceRegions operation returned by the service.
* @sample AmazonRDS.DescribeSourceRegions
* @see AWS API
* Documentation
*/
DescribeSourceRegionsResult describeSourceRegions(DescribeSourceRegionsRequest describeSourceRegionsRequest);
/**
*
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your
* DB instance. You can use this information when you call ModifyDBInstance.
*
*
* @param describeValidDBInstanceModificationsRequest
* @return Result of the DescribeValidDBInstanceModifications operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.DescribeValidDBInstanceModifications
* @see AWS API Documentation
*/
ValidDBInstanceModificationsMessage describeValidDBInstanceModifications(
DescribeValidDBInstanceModificationsRequest describeValidDBInstanceModificationsRequest);
/**
*
* Downloads all or a portion of the specified log file, up to 1 MB in size.
*
*
* @param downloadDBLogFilePortionRequest
* @return Result of the DownloadDBLogFilePortion operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBLogFileNotFoundException
* LogFileName doesn't refer to an existing DB log file.
* @sample AmazonRDS.DownloadDBLogFilePortion
* @see AWS
* API Documentation
*/
DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest);
/**
*
* Forces a failover for a DB cluster.
*
*
* A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the
* primary instance (the cluster writer).
*
*
* Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails.
* You can force a failover when you want to simulate a failure of a primary instance for testing. Because each
* instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing
* connections that use those endpoint addresses when the failover is complete.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param failoverDBClusterRequest
* @return Result of the FailoverDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.FailoverDBCluster
* @see AWS API
* Documentation
*/
DBCluster failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest);
/**
* Simplified method form for invoking the FailoverDBCluster operation.
*
* @see #failoverDBCluster(FailoverDBClusterRequest)
*/
DBCluster failoverDBCluster();
/**
*
* Imports the installation media for a DB engine that requires an on-premises customer provided license, such as
* SQL Server.
*
*
* @param importInstallationMediaRequest
* @return Result of the ImportInstallationMedia operation returned by the service.
* @throws CustomAvailabilityZoneNotFoundException
* CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.
* @throws InstallationMediaAlreadyExistsException
* The specified installation medium has already been imported.
* @sample AmazonRDS.ImportInstallationMedia
* @see AWS
* API Documentation
*/
ImportInstallationMediaResult importInstallationMedia(ImportInstallationMediaRequest importInstallationMediaRequest);
/**
*
* Lists all tags on an Amazon RDS resource.
*
*
* For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS
* Resources in the Amazon RDS User Guide.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @sample AmazonRDS.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS
* for new DB instances temporarily, 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 AWS Region.
*
*
* -
*
* RDS has already moved to a new default CA certificate for the specified AWS 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.
*
*
* @param modifyCertificatesRequest
* @return Result of the ModifyCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @sample AmazonRDS.ModifyCertificates
* @see AWS API
* Documentation
*/
Certificate modifyCertificates(ModifyCertificatesRequest modifyCertificatesRequest);
/**
*
* Set the capacity of an Aurora Serverless DB cluster to a specific value.
*
*
* Aurora Serverless 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 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, see Using Amazon Aurora
* Serverless in the Amazon Aurora User Guide.
*
*
*
* If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections
* that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling
* points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyCurrentDBClusterCapacityRequest
* @return Result of the ModifyCurrentDBClusterCapacity operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBClusterCapacityException
* Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
* 2, 4, 8, 16, 32, 64,
* 128, and 256.
* @sample AmazonRDS.ModifyCurrentDBClusterCapacity
* @see AWS API Documentation
*/
ModifyCurrentDBClusterCapacityResult modifyCurrentDBClusterCapacity(ModifyCurrentDBClusterCapacityRequest modifyCurrentDBClusterCapacityRequest);
/**
*
* Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by
* specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyDBClusterRequest
* @return Result of the ModifyDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDBSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws DBClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws InvalidDBSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @sample AmazonRDS.ModifyDBCluster
* @see AWS API
* Documentation
*/
DBCluster modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest);
/**
*
* Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyDBClusterEndpointRequest
* @return Result of the ModifyDBClusterEndpoint operation returned by the service.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBClusterEndpointStateException
* The requested operation can't be performed on the endpoint while the endpoint is in this state.
* @throws DBClusterEndpointNotFoundException
* The specified custom endpoint doesn't exist.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.ModifyDBClusterEndpoint
* @see AWS
* API Documentation
*/
ModifyDBClusterEndpointResult modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest modifyDBClusterEndpointRequest);
/**
*
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the
* following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
* parameters can be modified in a single request.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without
* failover to the DB cluster associated with the parameter group before the change can take effect.
*
*
*
* After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
* cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully
* complete the create action before the parameter group is used as the default for a new DB cluster. This is
* especially important for parameters that are critical when creating the default database for a DB cluster, such
* as the character set for the default database defined by the character_set_database parameter. You
* can use the Parameter Groups option of the Amazon RDS
* console or the DescribeDBClusterParameters action 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 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.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyDBClusterParameterGroupRequest
* @return Result of the ModifyDBClusterParameterGroup operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @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.
* @sample AmazonRDS.ModifyDBClusterParameterGroup
* @see AWS API Documentation
*/
ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest);
/**
*
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
*
*
* To share a manual DB cluster snapshot with other AWS accounts, specify restore as the
* AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS
* accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make
* the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts.
*
*
*
* Don't add the all value for any manual DB cluster snapshots that contain private information that
* you don't want available to all AWS accounts.
*
*
*
* If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS
* account IDs for the ValuesToAdd parameter. You can't use all as a value for that
* parameter in this case.
*
*
* To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB
* cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The
* accounts are returned as values for the restore attribute.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyDBClusterSnapshotAttributeRequest
* @return Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @sample AmazonRDS.ModifyDBClusterSnapshotAttribute
* @see AWS API Documentation
*/
DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest);
/**
*
* Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying
* these parameters and the new values in the request. To learn what modifications you can make to your DB instance,
* call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
*
*
* @param modifyDBInstanceRequest
* @return Result of the ModifyDBInstance operation returned by the service.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDBSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @throws DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws ProvisionedIopsNotAvailableInAZException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws DBUpgradeDependencyFailureException
* The DB upgrade failed because a resource the DB depends on can't be modified.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws BackupPolicyNotFoundException
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @sample AmazonRDS.ModifyDBInstance
* @see AWS API
* Documentation
*/
DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest);
/**
*
* Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the
* following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
* parameters can be modified in a single request.
*
*
*
* Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without
* failover to the DB instance associated with the parameter group before the change can take effect.
*
*
*
* After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
* that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the
* modify action before the parameter group is used as the default for a new DB instance. This is especially
* important for parameters that are critical when creating the default database for a DB instance, such as the
* character set for the default database defined by the character_set_database parameter. You can use
* the Parameter Groups option of the Amazon RDS console or
* the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*
*
*
* @param modifyDBParameterGroupRequest
* @return Result of the ModifyDBParameterGroup operation returned by the service.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @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.
* @sample AmazonRDS.ModifyDBParameterGroup
* @see AWS API
* Documentation
*/
ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest);
/**
*
* Changes the settings for an existing DB proxy.
*
*
* @param modifyDBProxyRequest
* @return Result of the ModifyDBProxy operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyAlreadyExistsException
* The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS
* Region.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @sample AmazonRDS.ModifyDBProxy
* @see AWS API
* Documentation
*/
ModifyDBProxyResult modifyDBProxy(ModifyDBProxyRequest modifyDBProxyRequest);
/**
*
* Modifies the properties of a DBProxyTargetGroup.
*
*
* @param modifyDBProxyTargetGroupRequest
* @return Result of the ModifyDBProxyTargetGroup operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @sample AmazonRDS.ModifyDBProxyTargetGroup
* @see AWS
* API Documentation
*/
ModifyDBProxyTargetGroupResult modifyDBProxyTargetGroup(ModifyDBProxyTargetGroupRequest modifyDBProxyTargetGroupRequest);
/**
*
* 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, Oracle, and PostgreSQL.
*
*
* @param modifyDBSnapshotRequest
* @return Result of the ModifyDBSnapshot operation returned by the service.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @sample AmazonRDS.ModifyDBSnapshot
* @see AWS API
* Documentation
*/
DBSnapshot modifyDBSnapshot(ModifyDBSnapshotRequest modifyDBSnapshotRequest);
/**
*
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
*
*
* To share a manual DB snapshot with other AWS accounts, specify restore as the
* AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS
* accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the
* manual DB snapshot public, which means it can be copied or restored by all AWS accounts.
*
*
*
* Don't add the all value for any manual DB snapshots that contain private information that you don't
* want available to all AWS accounts.
*
*
*
* If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account
* IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in
* this case.
*
*
* To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot
* public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values
* for the restore attribute.
*
*
* @param modifyDBSnapshotAttributeRequest
* @return Result of the ModifyDBSnapshotAttribute operation returned by the service.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InvalidDBSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @sample AmazonRDS.ModifyDBSnapshotAttribute
* @see AWS
* API Documentation
*/
DBSnapshotAttributesResult modifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest);
/**
*
* Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in
* the AWS Region.
*
*
* @param modifyDBSubnetGroupRequest
* @return Result of the ModifyDBSubnetGroup operation returned by the service.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetQuotaExceededException
* The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
* @throws SubnetAlreadyInUseException
* The DB subnet is already in use in the Availability Zone.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @sample AmazonRDS.ModifyDBSubnetGroup
* @see AWS API
* Documentation
*/
DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest);
/**
*
* 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.
*
*
* @param modifyEventSubscriptionRequest
* @return Result of the ModifyEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SNSInvalidTopicException
* SNS has responded that there is a problem with the SND topic specified.
* @throws SNSNoAuthorizationException
* You do not have permission to publish to the SNS topic ARN.
* @throws SNSTopicArnNotFoundException
* The SNS topic ARN does not exist.
* @throws SubscriptionCategoryNotFoundException
* The supplied category does not exist.
* @sample AmazonRDS.ModifyEventSubscription
* @see AWS
* API Documentation
*/
EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest);
/**
*
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration
* parameters by specifying these parameters and the new values in the request. For more information on Amazon
* Aurora, see What
* Is Amazon Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param modifyGlobalClusterRequest
* @return Result of the ModifyGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @sample AmazonRDS.ModifyGlobalCluster
* @see AWS API
* Documentation
*/
GlobalCluster modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest);
/**
*
* Modifies an existing option group.
*
*
* @param modifyOptionGroupRequest
* @return Result of the ModifyOptionGroup operation returned by the service.
* @throws InvalidOptionGroupStateException
* The option group isn't in the available state.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @sample AmazonRDS.ModifyOptionGroup
* @see AWS API
* Documentation
*/
OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest);
/**
*
* 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 and Aurora PostgreSQL.
*
*
*
*
*
* @param promoteReadReplicaRequest
* @return Result of the PromoteReadReplica operation returned by the service.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @sample AmazonRDS.PromoteReadReplica
* @see AWS API
* Documentation
*/
DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest);
/**
*
* Promotes a read replica DB cluster to a standalone DB cluster.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param promoteReadReplicaDBClusterRequest
* @return Result of the PromoteReadReplicaDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @sample AmazonRDS.PromoteReadReplicaDBCluster
* @see AWS API Documentation
*/
DBCluster promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest);
/**
*
* Purchases a reserved DB instance offering.
*
*
* @param purchaseReservedDBInstancesOfferingRequest
* @return Result of the PurchaseReservedDBInstancesOffering operation returned by the service.
* @throws ReservedDBInstancesOfferingNotFoundException
* Specified offering does not exist.
* @throws ReservedDBInstanceAlreadyExistsException
* User already has a reservation with the given identifier.
* @throws ReservedDBInstanceQuotaExceededException
* Request would exceed the user's DB Instance quota.
* @sample AmazonRDS.PurchaseReservedDBInstancesOffering
* @see AWS API Documentation
*/
ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest);
/**
*
* 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.
*
*
* @param rebootDBInstanceRequest
* @return Result of the RebootDBInstance operation returned by the service.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @sample AmazonRDS.RebootDBInstance
* @see AWS API
* Documentation
*/
DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest);
/**
*
* Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
*
*
* @param registerDBProxyTargetsRequest
* @return Result of the RegisterDBProxyTargets operation returned by the service.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBProxyTargetAlreadyRegisteredException
* The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBProxyStateException
* The requested operation can't be performed while the proxy is in this state.
* @throws InsufficientAvailableIPsInSubnetException
* The requested operation can't be performed because there aren't enough available IP addresses in the
* proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the
* subnets.
* @sample AmazonRDS.RegisterDBProxyTargets
* @see AWS API
* Documentation
*/
RegisterDBProxyTargetsResult registerDBProxyTargets(RegisterDBProxyTargetsRequest registerDBProxyTargetsRequest);
/**
*
* 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 action only applies to Aurora DB clusters.
*
*
*
* @param removeFromGlobalClusterRequest
* @return Result of the RemoveFromGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* @throws InvalidGlobalClusterStateException
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @sample AmazonRDS.RemoveFromGlobalCluster
* @see AWS
* API Documentation
*/
GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest);
/**
*
* Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more
* information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User
* Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param removeRoleFromDBClusterRequest
* @return Result of the RemoveRoleFromDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBClusterRoleNotFoundException
* The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @sample AmazonRDS.RemoveRoleFromDBCluster
* @see AWS
* API Documentation
*/
RemoveRoleFromDBClusterResult removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest);
/**
*
* Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
*
*
* @param removeRoleFromDBInstanceRequest
* @return Result of the RemoveRoleFromDBInstance operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBInstanceRoleNotFoundException
* The specified RoleArn value doesn't match the specified feature for the DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.RemoveRoleFromDBInstance
* @see AWS
* API Documentation
*/
RemoveRoleFromDBInstanceResult removeRoleFromDBInstance(RemoveRoleFromDBInstanceRequest removeRoleFromDBInstanceRequest);
/**
*
* Removes a source identifier from an existing RDS event notification subscription.
*
*
* @param removeSourceIdentifierFromSubscriptionRequest
* @return Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @sample AmazonRDS.RemoveSourceIdentifierFromSubscription
* @see AWS API Documentation
*/
EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest);
/**
*
* Removes metadata tags from an Amazon RDS resource.
*
*
* For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS
* Resources in the Amazon RDS User Guide.
*
*
* @param removeTagsFromResourceRequest
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBProxyNotFoundException
* The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS
* Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your AWS account in the specified AWS
* Region.
* @sample AmazonRDS.RemoveTagsFromResource
* @see AWS API
* Documentation
*/
RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest);
/**
*
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit
* a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster
* parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
* parameters.
*
*
* When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
* pending-reboot to take effect on the next DB instance restart or RebootDBInstance
* request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the
* updated static parameter to apply to.
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param resetDBClusterParameterGroupRequest
* @return 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.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.ResetDBClusterParameterGroup
* @see AWS API Documentation
*/
ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest);
/**
*
* 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.
*
*
* @param resetDBParameterGroupRequest
* @return 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.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @sample AmazonRDS.ResetDBParameterGroup
* @see AWS API
* Documentation
*/
ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest);
/**
*
* 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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
* CreateDBInstance action to create DB instances for the restored DB cluster, specifying the
* identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after
* the RestoreDBClusterFromS3 action 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 action only applies to Aurora DB clusters. The source DB engine must be MySQL.
*
*
*
* @param restoreDBClusterFromS3Request
* @return Result of the RestoreDBClusterFromS3 operation returned by the service.
* @throws DBClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DBClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBSubnetGroupStateException
* The DB subnet group cannot be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws 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.
* @throws DBClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws 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.
* @sample AmazonRDS.RestoreDBClusterFromS3
* @see AWS API
* Documentation
*/
DBCluster restoreDBClusterFromS3(RestoreDBClusterFromS3Request restoreDBClusterFromS3Request);
/**
*
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB
* clusters.
*
*
* 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 action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
* CreateDBInstance action to create DB instances for the restored DB cluster, specifying the
* identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after
* the RestoreDBClusterFromSnapshot action 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 action only applies to Aurora DB clusters.
*
*
*
* @param restoreDBClusterFromSnapshotRequest
* @return Result of the RestoreDBClusterFromSnapshot operation returned by the service.
* @throws DBClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DBClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws InsufficientDBClusterCapacityException
* The DB cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDBSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DBClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @sample AmazonRDS.RestoreDBClusterFromSnapshot
* @see AWS API Documentation
*/
DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest);
/**
*
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
* LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is
* created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB
* cluster is created with the default DB security group.
*
*
*
* This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
* CreateDBInstance action to create DB instances for the restored DB cluster, specifying the
* identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after
* the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
*
*
*
* For more information on Amazon Aurora, see What Is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param restoreDBClusterToPointInTimeRequest
* @return Result of the RestoreDBClusterToPointInTime operation returned by the service.
* @throws DBClusterAlreadyExistsException
* The user already has a DB cluster with the given identifier.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws InsufficientDBClusterCapacityException
* The DB cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDBClusterSnapshotStateException
* The supplied value isn't a valid DB cluster snapshot state.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DBClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
* @sample AmazonRDS.RestoreDBClusterToPointInTime
* @see AWS API Documentation
*/
DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest);
/**
*
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore
* point with the most of original configuration with the default security group and the default DB parameter group.
* By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server
* instance that has an option group that is associated with mirroring; in this case, the instance becomes a
* mirrored AZ deployment and not a single-AZ deployment.
*
*
* If your intent is to replace your original DB instance with the new, restored DB instance, then rename your
* original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB
* instances with the same name. Once you have renamed your original DB instance with a different identifier, then
* you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the
* RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB
* instance created from the snapshot.
*
*
* If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of
* the shared DB snapshot.
*
*
*
* This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
* RestoreDBClusterFromSnapshot.
*
*
*
* @param restoreDBInstanceFromDBSnapshotRequest
* @return Result of the RestoreDBInstanceFromDBSnapshot operation returned by the service.
* @throws DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws InvalidDBSnapshotStateException
* The state of the DB snapshot doesn't allow deletion.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws ProvisionedIopsNotAvailableInAZException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws BackupPolicyNotFoundException
* @sample AmazonRDS.RestoreDBInstanceFromDBSnapshot
* @see AWS API Documentation
*/
DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest);
/**
*
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can
* create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then
* restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into
* an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
*
*
* @param restoreDBInstanceFromS3Request
* @return Result of the RestoreDBInstanceFromS3 operation returned by the service.
* @throws DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws 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.
* @throws ProvisionedIopsNotAvailableInAZException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws BackupPolicyNotFoundException
* @sample AmazonRDS.RestoreDBInstanceFromS3
* @see AWS
* API Documentation
*/
DBInstance restoreDBInstanceFromS3(RestoreDBInstanceFromS3Request restoreDBInstanceFromS3Request);
/**
*
* 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 command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
* RestoreDBClusterToPointInTime.
*
*
*
* @param restoreDBInstanceToPointInTimeRequest
* @return Result of the RestoreDBInstanceToPointInTime operation returned by the service.
* @throws DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws PointInTimeRestoreNotEnabledException
* SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod
* equal to 0.
* @throws StorageQuotaExceededException
* The request would result in the user exceeding the allowed amount of storage available across all DB
* instances.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws InvalidRestoreException
* Cannot restore from VPC backup to non-VPC DB instance.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws ProvisionedIopsNotAvailableInAZException
* Provisioned IOPS not available in the specified Availability Zone.
* @throws OptionGroupNotFoundException
* The specified option group could not be found.
* @throws StorageTypeNotSupportedException
* Storage of the StorageType specified can't be associated with the DB instance.
* @throws 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.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws DomainNotFoundException
* Domain doesn't refer to an existing Active Directory domain.
* @throws BackupPolicyNotFoundException
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing DB parameter group.
* @throws DBInstanceAutomatedBackupNotFoundException
* No automated backup for this DB instance was found.
* @sample AmazonRDS.RestoreDBInstanceToPointInTime
* @see AWS API Documentation
*/
DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest);
/**
*
* 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).
*
*
* @param revokeDBSecurityGroupIngressRequest
* @return Result of the RevokeDBSecurityGroupIngress operation returned by the service.
* @throws DBSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing DB security group.
* @throws 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.
* @throws InvalidDBSecurityGroupStateException
* The state of the DB security group doesn't allow deletion.
* @sample AmazonRDS.RevokeDBSecurityGroupIngress
* @see AWS API Documentation
*/
DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest);
/**
*
* Starts a database activity stream to monitor activity on the database. For more information, see Database Activity
* Streams in the Amazon Aurora User Guide.
*
*
* @param startActivityStreamRequest
* @return Result of the StartActivityStream operation returned by the service.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @sample AmazonRDS.StartActivityStream
* @see AWS API
* Documentation
*/
StartActivityStreamResult startActivityStream(StartActivityStreamRequest startActivityStreamRequest);
/**
*
* Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command,
* or the StopDBCluster action.
*
*
* For more information, see Stopping and
* Starting an Aurora Cluster in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param startDBClusterRequest
* @return Result of the StartDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.StartDBCluster
* @see AWS API
* Documentation
*/
DBCluster startDBCluster(StartDBClusterRequest startDBClusterRequest);
/**
*
* Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or
* the StopDBInstance action.
*
*
* For more information, see Starting an Amazon RDS DB
* instance That Was Previously Stopped in the Amazon RDS User Guide.
*
*
*
* This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use
* StartDBCluster instead.
*
*
*
* @param startDBInstanceRequest
* @return Result of the StartDBInstance operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws InsufficientDBInstanceCapacityException
* The specified DB instance class isn't available in the specified Availability Zone.
* @throws DBSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing DB subnet group.
* @throws DBSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidSubnetException
* The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
* @throws InvalidVPCNetworkStateException
* The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws 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.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @sample AmazonRDS.StartDBInstance
* @see AWS API
* Documentation
*/
DBInstance startDBInstance(StartDBInstanceRequest startDBInstanceRequest);
/**
*
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
*
*
* @param startExportTaskRequest
* @return Result of the StartExportTask operation returned by the service.
* @throws DBSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
* @throws ExportTaskAlreadyExistsException
* You can't start an export task that's already running.
* @throws 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.
* @throws IamRoleNotFoundException
* The IAM role is missing for exporting to an Amazon S3 bucket.
* @throws IamRoleMissingPermissionsException
* The IAM role requires additional permissions to export to an Amazon S3 bucket.
* @throws InvalidExportOnlyException
* The export is invalid for exporting to an Amazon S3 bucket.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an AWS KMS key.
* @throws InvalidExportSourceStateException
* The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
* @sample AmazonRDS.StartExportTask
* @see AWS API
* Documentation
*/
StartExportTaskResult startExportTask(StartExportTaskRequest startExportTaskRequest);
/**
*
* Stops a database activity stream that was started using the AWS console, the start-activity-stream
* AWS CLI command, or the StartActivityStream action.
*
*
* For more information, see Database Activity
* Streams in the Amazon Aurora User Guide.
*
*
* @param stopActivityStreamRequest
* @return Result of the StopActivityStream operation returned by the service.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @sample AmazonRDS.StopActivityStream
* @see AWS API
* Documentation
*/
StopActivityStreamResult stopActivityStream(StopActivityStreamRequest stopActivityStreamRequest);
/**
*
* Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata,
* including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a
* point-in-time restore if necessary.
*
*
* For more information, see Stopping and
* Starting an Aurora Cluster in the Amazon Aurora User Guide.
*
*
*
* This action only applies to Aurora DB clusters.
*
*
*
* @param stopDBClusterRequest
* @return Result of the StopDBCluster operation returned by the service.
* @throws DBClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing DB cluster.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @sample AmazonRDS.StopDBCluster
* @see AWS API
* Documentation
*/
DBCluster stopDBCluster(StopDBClusterRequest stopDBClusterRequest);
/**
*
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata,
* including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction
* logs so you can do a point-in-time restore if necessary.
*
*
* For more information, see Stopping an Amazon RDS DB
* Instance Temporarily in the Amazon RDS User Guide.
*
*
*
* This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use
* StopDBCluster instead.
*
*
*
* @param stopDBInstanceRequest
* @return Result of the StopDBInstance operation returned by the service.
* @throws DBInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing DB instance.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @throws DBSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would result in the user exceeding the allowed number of DB snapshots.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @sample AmazonRDS.StopDBInstance
* @see AWS API
* Documentation
*/
DBInstance stopDBInstance(StopDBInstanceRequest stopDBInstanceRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AmazonRDSWaiters waiters();
}