/* * Copyright 2018-2023 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 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. *
** 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 with a DB cluster. *
* * @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 Amazon Web Services 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
.
*
* This command doesn't apply to RDS Custom. *
* * @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 Amazon Web Services 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 Amazon Web Services account in the
* specified Amazon Web Services Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
* specified Amazon Web Services Region.
* @throws BlueGreenDeploymentNotFoundException
* BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
* @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 Amazon Web Services Region to an Amazon RDS DB * instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB * instance in another. *
** For an overview of CIDR ranges, go to the Wikipedia Tutorial. *
** EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC * in the Amazon EC2 User Guide, the blog EC2-Classic Networking is * Retiring – Here’s How to Prepare, and Moving a DB instance not * in a VPC into a VPC in the Amazon RDS User Guide. *
*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 applies only to Aurora MySQL DB clusters. *
*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 or cluster 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. *
* * @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 Amazon Web Services Region. In that case, the Amazon
* Web Services Region where you call the CopyDBClusterSnapshot
operation is the destination Amazon Web
* Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot
* from another Amazon Web Services Region, you must provide the following values:
*
* KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier
* for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
*
* TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in
* the destination Amazon Web Services Region.
*
* SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
* snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is
* the same value as the SourceDBClusterSnapshotIdentifier
in the presigned URL.
*
* To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
* TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
*
* For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region * to another, see * Copying a Snapshot in the Amazon Aurora User Guide. *
** For more information on Amazon Aurora DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 Amazon Web Services 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 Amazon Web Services Region to another. In that case, the Amazon Web Services
* Region where you call the CopyDBSnapshot
operation is the destination Amazon Web Services Region for
* the DB snapshot copy.
*
* This command doesn't apply to RDS Custom. *
** For more information about copying snapshots, see Copying * a DB Snapshot in the Amazon RDS User Guide. *
* * @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 Amazon Web Services KMS key.
* @throws CustomAvailabilityZoneNotFoundException
* CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.
* @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 Amazon Web Services account. * @sample AmazonRDS.CopyOptionGroup * @see AWS API * Documentation */ OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest); /** ** Creates a blue/green deployment. *
** A blue/green deployment creates a staging environment that copies the production environment. In a blue/green * deployment, the blue environment is the current production environment. The green environment is the staging * environment. The staging environment stays in sync with the current production environment using logical * replication. *
** You can make changes to the databases in the green environment without affecting production workloads. For * example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes * in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch * over the environments to promote the green environment to be the new production environment. The switchover * typically takes under a minute. *
** For more information, see Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon Aurora User Guide. *
* * @param createBlueGreenDeploymentRequest * @return Result of the CreateBlueGreenDeployment 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 SourceDatabaseNotSupportedException
* The source DB instance isn't supported for a blue/green deployment.
* @throws SourceClusterNotSupportedException
* The source DB cluster isn't supported for a blue/green deployment.
* @throws BlueGreenDeploymentAlreadyExistsException
* A blue/green deployment with the specified name already exists.
* @throws DBParameterGroupNotFoundException
* DBParameterGroupName
doesn't refer to an existing DB parameter group.
* @throws DBClusterParameterGroupNotFoundException
* DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.
* @throws InstanceQuotaExceededException
* The request would result in the user exceeding the allowed number of DB instances.
* @throws DBClusterQuotaExceededException
* The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB
* cluster quota.
* @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.
* @sample AmazonRDS.CreateBlueGreenDeployment
* @see AWS
* API Documentation
*/
CreateBlueGreenDeploymentResult createBlueGreenDeployment(CreateBlueGreenDeploymentRequest createBlueGreenDeploymentRequest);
/**
* * Creates a custom DB engine version (CEV). *
* * @param createCustomDBEngineVersionRequest * @return Result of the CreateCustomDBEngineVersion operation returned by the service. * @throws CustomDBEngineVersionAlreadyExistsException * A CEV with the specified name already exists. * @throws CustomDBEngineVersionQuotaExceededException * You have exceeded your CEV quota. * @throws Ec2ImagePropertiesNotSupportedException * The AMI configuration prerequisite has not been met. * @throws KMSKeyNotAccessibleException * An error occurred accessing an Amazon Web Services KMS key. * @throws CreateCustomDBEngineVersionException * An error occurred while trying to create the CEV. * @sample AmazonRDS.CreateCustomDBEngineVersion * @see AWS API Documentation */ CreateCustomDBEngineVersionResult createCustomDBEngineVersion(CreateCustomDBEngineVersionRequest createCustomDBEngineVersionRequest); /** ** Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. *
** If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer * instance for your DB cluster using the CreateDBInstance * operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, * each in a different Availability Zone. *
*
* You can use the ReplicationSourceIdentifier
parameter to create an Amazon Aurora DB cluster as a
* read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about
* Amazon Aurora, see What is Amazon
* Aurora? in the Amazon Aurora User Guide.
*
* You can also use the ReplicationSourceIdentifier
parameter to create a Multi-AZ DB cluster read
* replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB
* clusters, see Multi-AZ DB
* cluster deployments in the Amazon RDS User Guide.
*
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 Amazon Web Services 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
* The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
* @throws InvalidGlobalClusterStateException
* The global cluster is in an invalid state and can't perform the requested operation.
* @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 applies only to Aurora DB clusters. *
*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 Aurora DB cluster, reboot the DB instances in * the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. *
** When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster * without failover for the new DB cluster parameter group and associated settings to take effect. *
*
* After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
* cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully
* complete the create action before the DB cluster parameter group is used as the default for a new DB cluster.
* This is especially important for parameters that are critical when creating the default database for a DB
* cluster, such as the character set for the default database defined by the character_set_database
* parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
* operation to verify that your DB cluster parameter group has been created or modified.
*
* For more information on Amazon Aurora, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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. *
** The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora * DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster. *
** For more information about creating an RDS DB instance, see Creating an Amazon RDS * DB instance in the Amazon RDS User Guide. *
** For more information about creating a DB instance in an Aurora DB cluster, see Creating an * Amazon Aurora DB cluster in the Amazon Aurora User Guide. *
* * @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
* The specified StorageType
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 Amazon Web Services KMS key.
* @throws DomainNotFoundException
* Domain
doesn't refer to an existing Active Directory domain.
* @throws BackupPolicyNotFoundException
* @throws NetworkTypeNotSupportedException
* The network type is invalid for the DB instance. Valid nework type values are IPV4
and
* DUAL
.
* @throws CertificateNotFoundException
* CertificateIdentifier
doesn't refer to an existing certificate.
* @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 or Multi-AZ DB cluster. * You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You * can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas * and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User * Guide. *
*
* Amazon Aurora doesn't support this operation. Call the CreateDBInstance
operation to create a DB
* instance for an Aurora DB cluster.
*
* All read replica DB instances are created with backups disabled. All other attributes (including DB security * groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified. *
** Your source DB instance or cluster must have backup retention enabled. *
*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 DBClusterNotFoundException
* DBClusterIdentifier
doesn't refer to an existing 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 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
* The specified StorageType
can't be associated with the DB instance.
* @throws KMSKeyNotAccessibleException
* An error occurred accessing an Amazon Web Services KMS key.
* @throws DomainNotFoundException
* Domain
doesn't refer to an existing Active Directory domain.
* @throws NetworkTypeNotSupportedException
* The network type is invalid for the DB instance. Valid nework type values are IPV4
and
* DUAL
.
* @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.
*
* This command doesn't apply to RDS Custom. *
*
* After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
* that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the
* create action before the parameter group is used as the default for a new DB instance. This is especially
* important for parameters that are critical when creating the default database for a DB instance, such as the
* character set for the default database defined by the character_set_database
parameter. You can use
* the Parameter Groups option of the Amazon RDS console or
* the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*
* 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 Amazon Web Services account in the * specified Amazon Web Services Region. * @throws DBProxyQuotaExceededException * Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web * Services Region. * @sample AmazonRDS.CreateDBProxy * @see AWS API * Documentation */ CreateDBProxyResult createDBProxy(CreateDBProxyRequest createDBProxyRequest); /** *
* Creates a DBProxyEndpoint
. Only applies to proxies that are associated with Aurora DB clusters. You
* can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy
* endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
*
* 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. *
** EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC * in the Amazon EC2 User Guide, the blog EC2-Classic Networking is * Retiring – Here’s How to Prepare, and Moving a DB instance not * in a VPC into a VPC in the Amazon RDS User Guide. *
*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-optimization
state.
*
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 * Amazon Web Services 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 operation requires a topic Amazon Resource Name (ARN) * created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a * topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. *
*
* You can specify the type of source (SourceType
) that you want to be notified of and provide a list
* of RDS sources (SourceIds
) that triggers the events. You can also provide a list of event categories
* (EventCategories
) for events that you want to be notified of. For example, you can specify
* SourceType
= db-instance
, SourceIds
= mydbinstance1
,
* mydbinstance2
and EventCategories
= Availability
, Backup
.
*
* If you specify both the SourceType
and SourceIds
, such as SourceType
=
* db-instance
and SourceIds
= myDBInstance1
, you are notified of all the
* db-instance
events for the specified source. If you specify a SourceType
but do not
* specify SourceIds
, you receive notice of the events for that source type for all your RDS sources.
* If you don't specify either the SourceType or the SourceIds
, you are notified of events generated
* from all RDS sources belonging to your customer account.
*
* For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon * RDS event notification in the Amazon RDS User Guide. *
** For more information about subscribing to an event for Aurora DB engines, see Subscribing to * Amazon RDS event notification in the Amazon Aurora User Guide. *
* * @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 SNS 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 Amazon Web Services Regions. The global database * contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives * data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. *
** You can create a global database that is initially empty, and then create the primary and secondary DB clusters * in the global database. Or you can specify an existing Aurora cluster during the create operation, and this * cluster becomes the primary cluster of the global database. *
** This operation applies only to Aurora DB clusters. *
*GlobalClusterIdentifier
already exists. Choose a new global database identifier (unique
* name) to create a new global database cluster.
* @throws GlobalClusterQuotaExceededException
* The number of global database clusters for this account is already at the maximum allowed.
* @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. *
** This command doesn't apply to RDS Custom. *
* * @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 Amazon Web Services account. * @sample AmazonRDS.CreateOptionGroup * @see AWS API * Documentation */ OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest); /** ** Deletes a blue/green deployment. *
** For more information, see Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon Aurora User Guide. *
* * @param deleteBlueGreenDeploymentRequest * @return Result of the DeleteBlueGreenDeployment operation returned by the service. * @throws BlueGreenDeploymentNotFoundException *BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
* @throws InvalidBlueGreenDeploymentStateException
* The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
* the green environment.
* @sample AmazonRDS.DeleteBlueGreenDeployment
* @see AWS
* API Documentation
*/
DeleteBlueGreenDeploymentResult deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest deleteBlueGreenDeploymentRequest);
/**
* * Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: *
** The CEV must not be the default for RDS Custom. If it is, change the default before running this command. *
** The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup * of your RDS Custom instance. *
** Typically, deletion takes a few minutes. *
*
* The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
* Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
* DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway
* that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
* DeleteCustomDbEngineVersion
event.
*
* For more information, see Deleting a * CEV in the Amazon RDS User Guide. *
* * @param deleteCustomDBEngineVersionRequest * @return Result of the DeleteCustomDBEngineVersion operation returned by the service. * @throws CustomDBEngineVersionNotFoundException * The specified CEV was not found. * @throws InvalidCustomDBEngineVersionStateException * You can't delete the CEV. * @sample AmazonRDS.DeleteCustomDBEngineVersion * @see AWS API Documentation */ DeleteCustomDBEngineVersionResult deleteCustomDBEngineVersion(DeleteCustomDBEngineVersionRequest deleteCustomDBEngineVersionRequest); /** ** The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all * automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the * specified DB cluster are not deleted. *
** If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas * are promoted to standalone instances. *
** For more information on Amazon Aurora, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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. *
** Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated * with any DB clusters. *
** For more information on Amazon Aurora, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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.
*
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 using the DbiResourceId
value of the source DB instance or the Amazon
* Resource Name (ARN) of the automated backups.
*
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 DB 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 Amazon Web Services account in the * specified Amazon Web Services 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 DBProxyEndpoint
. Doing so removes the ability to access the DB proxy using the endpoint
* that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only
* operations, or using a different VPC than the DB proxy's default VPC.
*
* Deletes a DB security group. *
** The specified DB security group must not be associated with any DB instances. *
** EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC * in the Amazon EC2 User Guide, the blog EC2-Classic Networking is * Retiring – Here’s How to Prepare, and Moving a DB instance not * in a VPC into a VPC in the Amazon RDS User Guide. *
*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.
*
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. *
*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. *
*GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
* @throws InvalidGlobalClusterStateException
* The global cluster is in an invalid state and can't perform the requested operation.
* @sample AmazonRDS.DeleteGlobalCluster
* @see AWS API
* Documentation
*/
GlobalCluster deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest);
/**
* * 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
.
*
* 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(); /** ** Describes one or more blue/green deployments. *
** For more information, see Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon Aurora User Guide. *
* * @param describeBlueGreenDeploymentsRequest * @return Result of the DescribeBlueGreenDeployments operation returned by the service. * @throws BlueGreenDeploymentNotFoundException *BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
* @sample AmazonRDS.DescribeBlueGreenDeployments
* @see AWS API Documentation
*/
DescribeBlueGreenDeploymentsResult describeBlueGreenDeployments(DescribeBlueGreenDeploymentsRequest describeBlueGreenDeploymentsRequest);
/**
* * Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account. *
** For more information, see Using SSL/TLS to encrypt a * connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to * encrypt a connection to a DB cluster in the Amazon Aurora User Guide. *
* * @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 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. *
*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. *
*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. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
* returns the restore
attribute and a list of IDs for the Amazon Web Services accounts that are
* authorized to copy or restore the manual DB cluster snapshot. If all
is included in the list of
* values for the restore
attribute, then the manual DB cluster snapshot is public and can be copied or
* restored by all Amazon Web Services accounts.
*
* To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to
* make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute
API
* action.
*
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 DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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();
/**
* * Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. *
** For more information on Amazon Aurora DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
** This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. *
* * @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); /** ** Describes provisioned RDS instances. This API supports pagination. *
** This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. *
*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. *
** This command doesn't apply to RDS Custom. *
* * @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.
*
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 Amazon Web Services account in the * specified Amazon Web Services Region. * @sample AmazonRDS.DescribeDBProxies * @see AWS API * Documentation */ DescribeDBProxiesResult describeDBProxies(DescribeDBProxiesRequest describeDBProxiesRequest); /** ** Returns information about DB proxy endpoints. *
* * @param describeDBProxyEndpointsRequest * @return Result of the DescribeDBProxyEndpoints operation returned by the service. * @throws DBProxyNotFoundException * The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the * specified Amazon Web Services Region. * @throws DBProxyEndpointNotFoundException * The DB proxy endpoint doesn't exist. * @sample AmazonRDS.DescribeDBProxyEndpoints * @see AWS * API Documentation */ DescribeDBProxyEndpointsResult describeDBProxyEndpoints(DescribeDBProxyEndpointsRequest describeDBProxyEndpointsRequest); /** *
* Returns information about DB proxy target groups, represented by DBProxyTargetGroup
data structures.
*
* Returns information about DBProxyTarget
objects. This API supports pagination.
*
* Returns a list of DBSecurityGroup
descriptions. If a DBSecurityGroupName
is specified,
* the list will contain only the descriptions of the specified DB security group.
*
* EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC * in the Amazon EC2 User Guide, the blog EC2-Classic Networking is * Retiring – Here’s How to Prepare, and Moving a DB instance not * in a VPC into a VPC in the Amazon RDS User Guide. *
*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 Amazon Web Services accounts, DescribeDBSnapshotAttributes
returns
* the restore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to
* copy or restore the manual DB snapshot. If all
is included in the list of values for the
* restore
attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon
* Web Services accounts.
*
* To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make
* the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute
API action.
*
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 * also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User * Guide or the Amazon Aurora * User Guide . *
* * @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.
*
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB * cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, * DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by * providing the name as a parameter. *
** For more information on working with events, see Monitoring Amazon RDS * events in the Amazon RDS User Guide and Monitoring Amazon * Aurora events in the Amazon Aurora User Guide. *
** By default, RDS returns events that were generated in the past hour. *
** Returns information about a snapshot or cluster 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. *
*GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
* @sample AmazonRDS.DescribeGlobalClusters
* @see AWS API
* Documentation
*/
DescribeGlobalClustersResult describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest);
/**
* * 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 DB engine, DB engine version, and DB instance * class. *
* * @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 Amazon Web Services Regions where the current Amazon Web Services Region can create * a read replica, copy a DB snapshot from, or replicate automated backups from. *
** Use this operation to determine whether cross-Region features are supported between other Regions and your * current Region. This operation supports pagination. *
*
* To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation
* DescribeRegions
. For more information, see DescribeRegions in
* the Amazon EC2 API Reference.
*
* You can call DescribeValidDBInstanceModifications
to learn what modifications you can make to your
* DB instance. You can use this information when you call ModifyDBInstance
.
*
* This command doesn't apply to RDS Custom. *
* * @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. *
** This command doesn't apply to RDS Custom. *
* * @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. *
** For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in * the DB cluster to be the primary DB instance (the cluster writer). *
** For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only * instances) in the DB cluster to be the primary DB instance (the cluster writer). *
** An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB * instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary * DB instance fails. *
** To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB * cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use * those endpoint addresses when the failover is complete. *
** For more information on Amazon Aurora DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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();
/**
* * Initiates the failover process for an Aurora global database (GlobalCluster). *
** A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB * cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role * of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB * cluster assumes full read/write capabilities for the Aurora global database. *
** For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide. *
** This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy * Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery * scenarios or to reconfigure your Aurora global database topology. *
*GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
* @throws InvalidGlobalClusterStateException
* The global cluster is in an invalid state and can't perform the requested operation.
* @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.FailoverGlobalCluster
* @see AWS API
* Documentation
*/
GlobalCluster failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest);
/**
* * 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 Amazon Web Services account in the
* specified Amazon Web Services Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
* specified Amazon Web Services Region.
* @throws BlueGreenDeploymentNotFoundException
* BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
* @sample AmazonRDS.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
* * Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked * policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you * can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream * isn't required. For more information, see Modifying a * database activity stream in the Amazon RDS User Guide. *
** This operation is supported for RDS for Oracle and Microsoft SQL Server. *
* * @param modifyActivityStreamRequest * @return Result of the ModifyActivityStream operation returned by the service. * @throws InvalidDBInstanceStateException * The DB instance isn't in a valid state. * @throws ResourceNotFoundException * The specified resource ID was not found. * @throws DBInstanceNotFoundException *DBInstanceIdentifier
doesn't refer to an existing DB instance.
* @sample AmazonRDS.ModifyActivityStream
* @see AWS API
* Documentation
*/
ModifyActivityStreamResult modifyActivityStream(ModifyActivityStreamRequest modifyActivityStreamRequest);
/**
* * Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS * for new DB instances, or remove the override. *
** By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is * different from the default certificate provided by RDS. You can also use this operation to remove the override, * so that new DB instances use the default certificate provided by RDS. *
** You might need to override the default certificate in the following situations: *
** You already migrated your applications to support the latest certificate authority (CA) certificate, but the new * CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region. *
** RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are * still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to * finish your application changes. *
** For more information about rotating your SSL/TLS certificate for RDS DB engines, see * Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide. *
** For more information about rotating your SSL/TLS certificate for Aurora DB engines, see * Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. *
* * @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 v1 DB cluster to a specific value. *
*
* Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might
* not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call
* ModifyCurrentDBClusterCapacity
to set the capacity explicitly.
*
* After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based * on the cooldown period for scaling up and the cooldown period for scaling down. *
** For more information about Aurora Serverless v1, see Using Amazon Aurora * Serverless v1 in the Amazon Aurora User Guide. *
*
* If you call ModifyCurrentDBClusterCapacity
with the default TimeoutAction
, connections
* that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about
* scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
*
* This action only applies to Aurora Serverless v1 DB clusters. *
*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);
/**
*
* Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling
* DescribeDBEngineVersions
.
*
* The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
* Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
* ModifyCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway
* that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
* ModifyCustomDbEngineVersion
event.
*
* For more information, see Modifying CEV * status in the Amazon RDS User Guide. *
* * @param modifyCustomDBEngineVersionRequest * @return Result of the ModifyCustomDBEngineVersion operation returned by the service. * @throws CustomDBEngineVersionNotFoundException * The specified CEV was not found. * @throws InvalidCustomDBEngineVersionStateException * You can't delete the CEV. * @sample AmazonRDS.ModifyCustomDBEngineVersion * @see AWS API Documentation */ ModifyCustomDBEngineVersionResult modifyCustomDBEngineVersion(ModifyCustomDBEngineVersionRequest modifyCustomDBEngineVersionRequest); /** ** Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more * settings by specifying these parameters and the new values in the request. *
** For more information on Amazon Aurora DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 DBInstanceAlreadyExistsException
* The user already has a DB instance with the given identifier.
* @throws DomainNotFoundException
* Domain
doesn't refer to an existing Active Directory domain.
* @throws StorageTypeNotAvailableException
* The aurora-iopt1
storage type isn't available, because you modified the DB cluster to use
* this storage type less than one month ago.
* @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. *
*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.
*
* 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
operation to verify that your DB cluster parameter
* group has been created or modified.
*
* If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update * immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any * connections and retry any transactions that were active when the parameter changes took effect. *
** For more information on Amazon Aurora DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 Amazon Web Services accounts, specify restore
as
* the AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon
* Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value
* all
to make the manual DB cluster snapshot public, which means that it can be copied or restored by
* all Amazon Web Services accounts.
*
* Don't add the all
value for any manual DB cluster snapshots that contain private information that
* you don't want available to all Amazon Web Services accounts.
*
* If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized
* Amazon Web Services account IDs for the ValuesToAdd
parameter. You can't use all
as a
* value for that parameter in this case.
*
* To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or
* whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API
* operation. The accounts are returned as values for the restore
attribute.
*
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
.
*
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
* The specified StorageType
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 Amazon Web Services KMS key.
* @throws InvalidDBClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws NetworkTypeNotSupportedException
* The network type is invalid for the DB instance. Valid nework type values are IPV4
and
* DUAL
.
* @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.
*
* 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.
*
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 Amazon Web Services account in the * specified Amazon Web Services Region. * @throws DBProxyAlreadyExistsException * The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the * specified Amazon Web Services 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); /** ** Changes the settings for an existing DB proxy endpoint. *
* * @param modifyDBProxyEndpointRequest * @return Result of the ModifyDBProxyEndpoint operation returned by the service. * @throws DBProxyEndpointNotFoundException * The DB proxy endpoint doesn't exist. * @throws DBProxyEndpointAlreadyExistsException * The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web * Services account in the specified Amazon Web Services Region. * @throws InvalidDBProxyEndpointStateException * You can't perform this operation while the DB proxy endpoint is in a particular state. * @throws InvalidDBProxyStateException * The requested operation can't be performed while the proxy is in this state. * @sample AmazonRDS.ModifyDBProxyEndpoint * @see AWS API * Documentation */ ModifyDBProxyEndpointResult modifyDBProxyEndpoint(ModifyDBProxyEndpointRequest modifyDBProxyEndpointRequest); /** *
* Modifies the properties of a DBProxyTargetGroup
.
*
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not * shared or public. *
** Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS * Custom. *
* * @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 Amazon Web Services accounts, specify restore
as the
* AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
* Services accounts that are authorized to restore the manual DB snapshot. Uses the value all
to make
* the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
*
* Don't add the all
value for any manual DB snapshots that contain private information that you don't
* want available to all Amazon Web Services accounts.
*
* If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web
* Services account IDs for the ValuesToAdd
parameter. You can't use all
as a value for
* that parameter in this case.
*
* To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a
* manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are
* returned as values for the restore
attribute.
*
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 Amazon Web Services 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.
*
* Modifies 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 operation only applies to Aurora global database clusters. *
*GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
* @throws InvalidGlobalClusterStateException
* The global cluster is in an invalid state and can't perform the requested operation.
* @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.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, Aurora PostgreSQL, or RDS Custom. *
*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. *
* * @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 cluster, usually for maintenance reasons. For example, if you make certain * modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB * cluster for the changes to take effect. *
** Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary * outage, during which the DB cluster status is set to rebooting. *
** Use this operation only for a non-Aurora Multi-AZ DB cluster. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @param rebootDBClusterRequest * @return Result of the RebootDBCluster 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.RebootDBCluster
* @see AWS API
* Documentation
*/
DBCluster rebootDBCluster(RebootDBClusterRequest rebootDBClusterRequest);
/**
* * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain * modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the * instance for the changes to take effect. *
** Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary * outage, during which the DB instance status is set to rebooting. *
** For more information about rebooting, see Rebooting a DB * Instance in the Amazon RDS User Guide. *
** This command doesn't apply to RDS Custom. *
*
* If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the
* RebootDBCluster
operation.
*
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
.
*
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. *
*GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
* @throws InvalidGlobalClusterStateException
* The global cluster is in an invalid state and can't perform the requested operation.
* @throws DBClusterNotFoundException
* DBClusterIdentifier
doesn't refer to an existing DB cluster.
* @sample AmazonRDS.RemoveFromGlobalCluster
* @see AWS
* API Documentation
*/
GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest);
/**
* * Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. *
** For more information on Amazon Aurora DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 Amazon Web Services 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 Amazon Web Services account in the
* specified Amazon Web Services Region.
* @throws DBProxyTargetGroupNotFoundException
* The specified target group isn't available for a proxy owned by your Amazon Web Services account in the
* specified Amazon Web Services Region.
* @throws BlueGreenDeploymentNotFoundException
* BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
* @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 DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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.
*
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. *
*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 Amazon Web Services 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.
* @throws StorageTypeNotSupportedException
* The specified StorageType
can't be associated with the DB instance.
* @sample AmazonRDS.RestoreDBClusterFromS3
* @see AWS API
* Documentation
*/
DBCluster restoreDBClusterFromS3(RestoreDBClusterFromS3Request restoreDBClusterFromS3Request);
/**
* * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. *
** The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a * security group, the new DB cluster is associated with the default security group. *
*
* This 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 DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 Amazon Web Services 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.
* @throws InvalidDBInstanceStateException
* The DB instance isn't in a valid state.
* @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.
*
* For Aurora, 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 DB clusters, see What is Amazon * Aurora? in the Amazon Aurora User Guide. *
** For more information on Multi-AZ DB clusters, see Multi-AZ DB * cluster deployments in the Amazon RDS User Guide. *
* * @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 Amazon Web Services 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 most of the source's original configuration, including the default security group and DB parameter * group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL * Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ * deployment, not a Single-AZ deployment. *
** If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB * instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the * same name. After you have renamed your original DB instance with a different identifier, then you can pass the * original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot * action. The result is that you replace the original DB instance with the DB instance created from the snapshot. *
*
* If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of
* the shared DB snapshot.
*
* This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use
* RestoreDBClusterFromSnapshot
.
*
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
* The specified StorageType
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 Amazon Web Services 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
* @throws NetworkTypeNotSupportedException
* The network type is invalid for the DB instance. Valid nework type values are IPV4
and
* DUAL
.
* @throws DBClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.
* @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. *
** This command doesn't apply to RDS Custom. *
* * @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
* The specified StorageType
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 Amazon Web Services KMS key.
* @throws BackupPolicyNotFoundException
* @throws NetworkTypeNotSupportedException
* The network type is invalid for the DB instance. Valid nework type values are IPV4
and
* DUAL
.
* @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
.
*
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
* The specified StorageType
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 Amazon Web Services 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.
* @throws NetworkTypeNotSupportedException
* The network type is invalid for the DB instance. Valid nework type values are IPV4
and
* DUAL
.
* @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). *
** EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC * in the Amazon EC2 User Guide, the blog EC2-Classic Networking is * Retiring – Here’s How to Prepare, and Moving a DB instance not * in a VPC into a VPC in the Amazon RDS User Guide. *
*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 Monitoring Amazon * Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with * Database Activity Streams in the Amazon RDS 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 Amazon Web Services KMS key.
* @sample AmazonRDS.StartActivityStream
* @see AWS API
* Documentation
*/
StartActivityStreamResult startActivityStream(StartActivityStreamRequest startActivityStreamRequest);
/**
* * Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster * 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. *
*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 Amazon Web Services console, the stop-db-instance 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 RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use
* StartDBCluster
instead.
*
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 Amazon Web Services KMS key. * @sample AmazonRDS.StartDBInstance * @see AWS API * Documentation */ DBInstance startDBInstance(StartDBInstanceRequest startDBInstanceRequest); /** *
* Enables replication of automated backups to a different Amazon Web Services Region. *
** This command doesn't apply to RDS Custom. *
** For more information, see Replicating Automated * Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. *
* * @param startDBInstanceAutomatedBackupsReplicationRequest * @return Result of the StartDBInstanceAutomatedBackupsReplication 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 KMSKeyNotAccessibleException
* An error occurred accessing an Amazon Web Services KMS key.
* @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.
* @throws StorageTypeNotSupportedException
* The specified StorageType
can't be associated with the DB instance.
* @sample AmazonRDS.StartDBInstanceAutomatedBackupsReplication
* @see AWS API Documentation
*/
DBInstanceAutomatedBackup startDBInstanceAutomatedBackupsReplication(
StartDBInstanceAutomatedBackupsReplicationRequest startDBInstanceAutomatedBackupsReplicationRequest);
/**
* * Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 * bucket. *
** You can't export snapshot data from RDS Custom DB instances. *
** You can't export cluster data from Multi-AZ DB clusters. *
** For more information on exporting DB snapshot data, see Exporting DB snapshot data * to Amazon S3 in the Amazon RDS User Guide or Exporting DB * cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide. *
** For more information on exporting DB cluster data, see Exporting DB cluster * data to Amazon S3 in the Amazon Aurora User Guide. *
* * @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 DBClusterNotFoundException
* DBClusterIdentifier
doesn't refer to an existing DB cluster.
* @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 Amazon Web Services 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 Amazon Web Services console, the
* start-activity-stream
CLI command, or the StartActivityStream
action.
*
* For more information, see Monitoring Amazon * Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with * Database Activity Streams in the Amazon RDS 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. *
*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 RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use
* StopDBCluster
instead.
*
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);
/**
* * Stops automated backup replication for a DB instance. *
** This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. *
** For more information, see Replicating Automated * Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. *
* * @param stopDBInstanceAutomatedBackupsReplicationRequest * @return Result of the StopDBInstanceAutomatedBackupsReplication 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.StopDBInstanceAutomatedBackupsReplication
* @see AWS API Documentation
*/
DBInstanceAutomatedBackup stopDBInstanceAutomatedBackupsReplication(
StopDBInstanceAutomatedBackupsReplicationRequest stopDBInstanceAutomatedBackupsReplicationRequest);
/**
* * Switches over a blue/green deployment. *
** Before you switch over, production traffic is routed to the databases in the blue environment. After you switch * over, production traffic is routed to the databases in the green environment. *
** For more information, see Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS * Blue/Green Deployments for database updates in the Amazon Aurora User Guide. *
* * @param switchoverBlueGreenDeploymentRequest * @return Result of the SwitchoverBlueGreenDeployment operation returned by the service. * @throws BlueGreenDeploymentNotFoundException *BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
* @throws InvalidBlueGreenDeploymentStateException
* The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
* the green environment.
* @sample AmazonRDS.SwitchoverBlueGreenDeployment
* @see AWS API Documentation
*/
SwitchoverBlueGreenDeploymentResult switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest switchoverBlueGreenDeploymentRequest);
/**
* * Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. * Issue this command in the Region that hosts the current standby database. *
* * @param switchoverReadReplicaRequest * @return Result of the SwitchoverReadReplica 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.SwitchoverReadReplica
* @see AWS API
* Documentation
*/
DBInstance switchoverReadReplica(SwitchoverReadReplicaRequest switchoverReadReplicaRequest);
/**
* 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(); }