AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.
Namespace: Amazon.RDS
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonRDSClient : AmazonServiceClient IAmazonRDS, IDisposable
The AmazonRDSClient type exposes the following members
Name | Description | |
---|---|---|
AmazonRDSClient() |
Constructs AmazonRDSClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonRDSClient(RegionEndpoint) |
Constructs AmazonRDSClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonRDSClient(AmazonRDSConfig) |
Constructs AmazonRDSClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonRDSClient(AWSCredentials) | Constructs AmazonRDSClient with AWS Credentials | |
AmazonRDSClient(AWSCredentials, RegionEndpoint) | Constructs AmazonRDSClient with AWS Credentials | |
AmazonRDSClient(AWSCredentials, AmazonRDSConfig) | Constructs AmazonRDSClient with AWS Credentials and an AmazonRDSClient Configuration object. | |
AmazonRDSClient(string, string) | Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key | |
AmazonRDSClient(string, string, RegionEndpoint) | Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key | |
AmazonRDSClient(string, string, AmazonRDSConfig) | Constructs AmazonRDSClient with AWS Access Key ID, AWS Secret Key and an AmazonRDSClient Configuration object. | |
AmazonRDSClient(string, string, string) | Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key | |
AmazonRDSClient(string, string, string, RegionEndpoint) | Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key | |
AmazonRDSClient(string, string, string, AmazonRDSConfig) | Constructs AmazonRDSClient with AWS Access Key ID, AWS Secret Key and an AmazonRDSClient Configuration object. |
Name | Description | |
---|---|---|
AddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest) | Adds a source identifier to an existing RDS event notification subscription. | |
AddTagsToResource(AddTagsToResourceRequest) |
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost
allocation reporting to track cost associated with Amazon RDS resources, or used in
a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources. |
|
ApplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest) | Applies a pending maintenance action to a resource (for example, to a DB instance). | |
AuthorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest) |
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First,
EC2 or VPC security groups can be added to the DBSecurityGroup if the application
using the database is running on EC2 or VPC instances. Second, IP ranges are available
if the application accessing your database is running on the Internet. Required parameters
for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId
and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
|
BeginAddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AddSourceIdentifierToSubscription operation. | |
BeginAddTagsToResource(AddTagsToResourceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AddTagsToResource operation. | |
BeginApplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ApplyPendingMaintenanceAction operation. | |
BeginAuthorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation. | |
BeginCopyDBClusterSnapshot(CopyDBClusterSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CopyDBClusterSnapshot operation. | |
BeginCopyDBParameterGroup(CopyDBParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CopyDBParameterGroup operation. | |
BeginCopyDBSnapshot(CopyDBSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CopyDBSnapshot operation. | |
BeginCopyOptionGroup(CopyOptionGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CopyOptionGroup operation. | |
BeginCreateDBCluster(CreateDBClusterRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBCluster operation. | |
BeginCreateDBClusterParameterGroup(CreateDBClusterParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBClusterParameterGroup operation. | |
BeginCreateDBClusterSnapshot(CreateDBClusterSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBClusterSnapshot operation. | |
BeginCreateDBInstance(CreateDBInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBInstance operation. | |
BeginCreateDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBInstanceReadReplica operation. | |
BeginCreateDBParameterGroup(CreateDBParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBParameterGroup operation. | |
BeginCreateDBSecurityGroup(CreateDBSecurityGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBSecurityGroup operation. | |
BeginCreateDBSnapshot(CreateDBSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBSnapshot operation. | |
BeginCreateDBSubnetGroup(CreateDBSubnetGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateDBSubnetGroup operation. | |
BeginCreateEventSubscription(CreateEventSubscriptionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateEventSubscription operation. | |
BeginCreateOptionGroup(CreateOptionGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateOptionGroup operation. | |
BeginDeleteDBCluster(DeleteDBClusterRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBCluster operation. | |
BeginDeleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBClusterParameterGroup operation. | |
BeginDeleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBClusterSnapshot operation. | |
BeginDeleteDBInstance(DeleteDBInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBInstance operation. | |
BeginDeleteDBParameterGroup(DeleteDBParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBParameterGroup operation. | |
BeginDeleteDBSecurityGroup(DeleteDBSecurityGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBSecurityGroup operation. | |
BeginDeleteDBSnapshot(DeleteDBSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBSnapshot operation. | |
BeginDeleteDBSubnetGroup(DeleteDBSubnetGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteDBSubnetGroup operation. | |
BeginDeleteEventSubscription(DeleteEventSubscriptionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteEventSubscription operation. | |
BeginDeleteOptionGroup(DeleteOptionGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteOptionGroup operation. | |
BeginDescribeAccountAttributes(DescribeAccountAttributesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeAccountAttributes operation. | |
BeginDescribeCertificates(DescribeCertificatesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeCertificates operation. | |
BeginDescribeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBClusterParameterGroups operation. | |
BeginDescribeDBClusterParameters(DescribeDBClusterParametersRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBClusterParameters operation. | |
BeginDescribeDBClusters(DescribeDBClustersRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBClusters operation. | |
BeginDescribeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBClusterSnapshots operation. | |
BeginDescribeDBEngineVersions(DescribeDBEngineVersionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBEngineVersions operation. | |
BeginDescribeDBInstances(DescribeDBInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBInstances operation. | |
BeginDescribeDBLogFiles(DescribeDBLogFilesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBLogFiles operation. | |
BeginDescribeDBParameterGroups(DescribeDBParameterGroupsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBParameterGroups operation. | |
BeginDescribeDBParameters(DescribeDBParametersRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBParameters operation. | |
BeginDescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBSecurityGroups operation. | |
BeginDescribeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBSnapshotAttributes operation. | |
BeginDescribeDBSnapshots(DescribeDBSnapshotsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBSnapshots operation. | |
BeginDescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeDBSubnetGroups operation. | |
BeginDescribeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeEngineDefaultClusterParameters operation. | |
BeginDescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. | |
BeginDescribeEventCategories(DescribeEventCategoriesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeEventCategories operation. | |
BeginDescribeEvents(DescribeEventsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeEvents operation. | |
BeginDescribeEventSubscriptions(DescribeEventSubscriptionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeEventSubscriptions operation. | |
BeginDescribeOptionGroupOptions(DescribeOptionGroupOptionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeOptionGroupOptions operation. | |
BeginDescribeOptionGroups(DescribeOptionGroupsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeOptionGroups operation. | |
BeginDescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeOrderableDBInstanceOptions operation. | |
BeginDescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribePendingMaintenanceActions operation. | |
BeginDescribeReservedDBInstances(DescribeReservedDBInstancesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeReservedDBInstances operation. | |
BeginDescribeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeReservedDBInstancesOfferings operation. | |
BeginDownloadDBLogFilePortion(DownloadDBLogFilePortionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DownloadDBLogFilePortion operation. | |
BeginFailoverDBCluster(FailoverDBClusterRequest, AsyncCallback, object) | Initiates the asynchronous execution of the FailoverDBCluster operation. | |
BeginListTagsForResource(ListTagsForResourceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListTagsForResource operation. | |
BeginModifyDBCluster(ModifyDBClusterRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyDBCluster operation. | |
BeginModifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyDBClusterParameterGroup operation. | |
BeginModifyDBInstance(ModifyDBInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyDBInstance operation. | |
BeginModifyDBParameterGroup(ModifyDBParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyDBParameterGroup operation. | |
BeginModifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyDBSnapshotAttribute operation. | |
BeginModifyDBSubnetGroup(ModifyDBSubnetGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyDBSubnetGroup operation. | |
BeginModifyEventSubscription(ModifyEventSubscriptionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyEventSubscription operation. | |
BeginModifyOptionGroup(ModifyOptionGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ModifyOptionGroup operation. | |
BeginPromoteReadReplica(PromoteReadReplicaRequest, AsyncCallback, object) | Initiates the asynchronous execution of the PromoteReadReplica operation. | |
BeginPurchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest, AsyncCallback, object) | Initiates the asynchronous execution of the PurchaseReservedDBInstancesOffering operation. | |
BeginRebootDBInstance(RebootDBInstanceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RebootDBInstance operation. | |
BeginRemoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RemoveSourceIdentifierFromSubscription operation. | |
BeginRemoveTagsFromResource(RemoveTagsFromResourceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RemoveTagsFromResource operation. | |
BeginResetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ResetDBClusterParameterGroup operation. | |
BeginResetDBParameterGroup(ResetDBParameterGroupRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ResetDBParameterGroup operation. | |
BeginRestoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RestoreDBClusterFromSnapshot operation. | |
BeginRestoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RestoreDBClusterToPointInTime operation. | |
BeginRestoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation. | |
BeginRestoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RestoreDBInstanceToPointInTime operation. | |
BeginRevokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RevokeDBSecurityGroupIngress operation. | |
CopyDBClusterSnapshot(CopyDBClusterSnapshotRequest) | Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. | |
CopyDBParameterGroup(CopyDBParameterGroupRequest) | Copies the specified DB parameter group. | |
CopyDBSnapshot(CopyDBSnapshotRequest) |
Copies the specified DBSnapshot. The source DB snapshot must be in the "available"
state.
If you are copying from a shared manual DB snapshot, the |
|
CopyOptionGroup(CopyOptionGroupRequest) | Copies the specified option group. | |
CreateDBCluster(CreateDBClusterRequest) | Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. | |
CreateDBClusterParameterGroup(CreateDBClusterParameterGroupRequest) |
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes
before creating your first DB cluster that uses that DB cluster parameter group as
the default parameter group. This allows Amazon RDS to fully complete the create action
before the DB cluster parameter group is used as the default for a new DB cluster.
This is especially important for parameters that are critical when creating the default
database for a DB cluster, such as the character set for the default database defined
by the For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
CreateDBClusterSnapshot(CreateDBClusterSnapshotRequest) | Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. | |
CreateDBInstance(CreateDBInstanceRequest) | Creates a new DB instance. | |
CreateDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest) |
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that
acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. The source DB instance must have backup retention enabled. |
|
CreateDBParameterGroup(CreateDBParameterGroupRequest) |
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating
your first DB instance that uses that DB parameter group as the default parameter
group. This allows Amazon RDS to fully complete the create action before the parameter
group is used as the default for a new DB instance. This is especially important for
parameters that are critical when creating the default database for a DB instance,
such as the character set for the default database defined by the |
|
CreateDBSecurityGroup(CreateDBSecurityGroupRequest) | Creates a new DB security group. DB security groups control access to a DB instance. | |
CreateDBSnapshot(CreateDBSnapshotRequest) | Creates a DBSnapshot. The source DBInstance must be in "available" state. | |
CreateDBSubnetGroup(CreateDBSubnetGroupRequest) | Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. | |
CreateEventSubscription(CreateEventSubscriptionRequest) |
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon
Resource Name) created by either the RDS console, the SNS console, or the SNS API.
To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to
the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account. |
|
CreateOptionGroup(CreateOptionGroupRequest) | Creates a new option group. You can create up to 20 option groups. | |
DeleteDBCluster(DeleteDBClusterRequest) |
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful
response from the web service indicates the request was received correctly. When you
delete a DB cluster, all automated backups for that DB cluster are deleted and cannot
be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not
deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DeleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest) |
Deletes a specified DB cluster parameter group. The DB cluster parameter group to
be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DeleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest) |
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation
is terminated.
available state to be deleted.For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DeleteDBInstance(DeleteDBInstanceRequest) |
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful
response from the web service indicates the request was received correctly. When you
delete a DB instance, all automated backups for that instance are deleted and cannot
be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be "deleting"
until the DB snapshot is created. The API action Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". |
|
DeleteDBParameterGroup(DeleteDBParameterGroupRequest) | Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances. | |
DeleteDBSecurityGroup(DeleteDBSecurityGroupRequest) |
Deletes a DB security group.
|
|
DeleteDBSnapshot(DeleteDBSnapshotRequest) |
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
available state to be deleted. |
|
DeleteDBSubnetGroup(DeleteDBSubnetGroupRequest) |
Deletes a DB subnet group.
|
|
DeleteEventSubscription(DeleteEventSubscriptionRequest) | Deletes an RDS event notification subscription. | |
DeleteOptionGroup(DeleteOptionGroupRequest) | Deletes an existing option group. | |
DescribeAccountAttributes() |
Lists all of the attributes for a customer account. The attributes include Amazon
RDS quotas for the account, such as the number of DB instances allowed. The description
for a quota includes the quota name, current usage toward that quota, and the quota's
maximum value.
This command does not take any parameters. |
|
DescribeAccountAttributes(DescribeAccountAttributesRequest) |
Lists all of the attributes for a customer account. The attributes include Amazon
RDS quotas for the account, such as the number of DB instances allowed. The description
for a quota includes the quota name, current usage toward that quota, and the quota's
maximum value.
This command does not take any parameters. |
|
DescribeCertificates(DescribeCertificatesRequest) | Lists the set of CA certificates provided by Amazon RDS for this AWS account. | |
DescribeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest) |
Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified
DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DescribeDBClusterParameters(DescribeDBClusterParametersRequest) |
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DescribeDBClusters(DescribeDBClustersRequest) |
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DescribeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest) |
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DescribeDBEngineVersions() | Returns a list of the available DB engines. | |
DescribeDBEngineVersions(DescribeDBEngineVersionsRequest) | Returns a list of the available DB engines. | |
DescribeDBInstances() | Returns information about provisioned RDS instances. This API supports pagination. | |
DescribeDBInstances(DescribeDBInstancesRequest) | Returns information about provisioned RDS instances. This API supports pagination. | |
DescribeDBLogFiles(DescribeDBLogFilesRequest) | Returns a list of DB log files for the DB instance. | |
DescribeDBParameterGroups() |
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter
group.
|
|
DescribeDBParameterGroups(DescribeDBParameterGroupsRequest) |
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter
group.
|
|
DescribeDBParameters(DescribeDBParametersRequest) | Returns the detailed parameter list for a particular DB parameter group. | |
DescribeDBSecurityGroups() |
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security
group.
|
|
DescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest) |
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName
is specified, the list will contain only the descriptions of the specified DB security
group.
|
|
DescribeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest) |
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts, To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API. |
|
DescribeDBSnapshots() | Returns information about DB snapshots. This API supports pagination. | |
DescribeDBSnapshots(DescribeDBSnapshotsRequest) | Returns information about DB snapshots. This API supports pagination. | |
DescribeDBSubnetGroups() |
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. |
|
DescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest) |
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified,
the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
|
DescribeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest) |
Returns the default engine and system parameter information for the cluster database
engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest) | Returns the default engine and system parameter information for the specified database engine. | |
DescribeEventCategories() | Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide. | |
DescribeEventCategories(DescribeEventCategoriesRequest) | Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide. | |
DescribeEvents() | Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. | |
DescribeEvents(DescribeEventsRequest) | Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. | |
DescribeEventSubscriptions() |
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. |
|
DescribeEventSubscriptions(DescribeEventSubscriptionsRequest) |
Lists all the subscription descriptions for a customer account. The description for
a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID,
CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription. |
|
DescribeOptionGroupOptions(DescribeOptionGroupOptionsRequest) | Describes all available options. | |
DescribeOptionGroups() | Describes the available option groups. | |
DescribeOptionGroups(DescribeOptionGroupsRequest) | Describes the available option groups. | |
DescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest) | Returns a list of orderable DB instance options for the specified engine. | |
DescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest) | Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. | |
DescribeReservedDBInstances() | Returns information about reserved DB instances for this account, or about a specified reserved DB instance. | |
DescribeReservedDBInstances(DescribeReservedDBInstancesRequest) | Returns information about reserved DB instances for this account, or about a specified reserved DB instance. | |
DescribeReservedDBInstancesOfferings() | Lists available reserved DB instance offerings. | |
DescribeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest) | Lists available reserved DB instance offerings. | |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
DownloadDBLogFilePortion(DownloadDBLogFilePortionRequest) | Downloads all or a portion of the specified log file, up to 1 MB in size. | |
EndAddSourceIdentifierToSubscription(IAsyncResult) | Finishes the asynchronous execution of the AddSourceIdentifierToSubscription operation. | |
EndAddTagsToResource(IAsyncResult) | Finishes the asynchronous execution of the AddTagsToResource operation. | |
EndApplyPendingMaintenanceAction(IAsyncResult) | Finishes the asynchronous execution of the ApplyPendingMaintenanceAction operation. | |
EndAuthorizeDBSecurityGroupIngress(IAsyncResult) | Finishes the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation. | |
EndCopyDBClusterSnapshot(IAsyncResult) | Finishes the asynchronous execution of the CopyDBClusterSnapshot operation. | |
EndCopyDBParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the CopyDBParameterGroup operation. | |
EndCopyDBSnapshot(IAsyncResult) | Finishes the asynchronous execution of the CopyDBSnapshot operation. | |
EndCopyOptionGroup(IAsyncResult) | Finishes the asynchronous execution of the CopyOptionGroup operation. | |
EndCreateDBCluster(IAsyncResult) | Finishes the asynchronous execution of the CreateDBCluster operation. | |
EndCreateDBClusterParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the CreateDBClusterParameterGroup operation. | |
EndCreateDBClusterSnapshot(IAsyncResult) | Finishes the asynchronous execution of the CreateDBClusterSnapshot operation. | |
EndCreateDBInstance(IAsyncResult) | Finishes the asynchronous execution of the CreateDBInstance operation. | |
EndCreateDBInstanceReadReplica(IAsyncResult) | Finishes the asynchronous execution of the CreateDBInstanceReadReplica operation. | |
EndCreateDBParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the CreateDBParameterGroup operation. | |
EndCreateDBSecurityGroup(IAsyncResult) | Finishes the asynchronous execution of the CreateDBSecurityGroup operation. | |
EndCreateDBSnapshot(IAsyncResult) | Finishes the asynchronous execution of the CreateDBSnapshot operation. | |
EndCreateDBSubnetGroup(IAsyncResult) | Finishes the asynchronous execution of the CreateDBSubnetGroup operation. | |
EndCreateEventSubscription(IAsyncResult) | Finishes the asynchronous execution of the CreateEventSubscription operation. | |
EndCreateOptionGroup(IAsyncResult) | Finishes the asynchronous execution of the CreateOptionGroup operation. | |
EndDeleteDBCluster(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBCluster operation. | |
EndDeleteDBClusterParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBClusterParameterGroup operation. | |
EndDeleteDBClusterSnapshot(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBClusterSnapshot operation. | |
EndDeleteDBInstance(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBInstance operation. | |
EndDeleteDBParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBParameterGroup operation. | |
EndDeleteDBSecurityGroup(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBSecurityGroup operation. | |
EndDeleteDBSnapshot(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBSnapshot operation. | |
EndDeleteDBSubnetGroup(IAsyncResult) | Finishes the asynchronous execution of the DeleteDBSubnetGroup operation. | |
EndDeleteEventSubscription(IAsyncResult) | Finishes the asynchronous execution of the DeleteEventSubscription operation. | |
EndDeleteOptionGroup(IAsyncResult) | Finishes the asynchronous execution of the DeleteOptionGroup operation. | |
EndDescribeAccountAttributes(IAsyncResult) | Finishes the asynchronous execution of the DescribeAccountAttributes operation. | |
EndDescribeCertificates(IAsyncResult) | Finishes the asynchronous execution of the DescribeCertificates operation. | |
EndDescribeDBClusterParameterGroups(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBClusterParameterGroups operation. | |
EndDescribeDBClusterParameters(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBClusterParameters operation. | |
EndDescribeDBClusters(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBClusters operation. | |
EndDescribeDBClusterSnapshots(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBClusterSnapshots operation. | |
EndDescribeDBEngineVersions(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBEngineVersions operation. | |
EndDescribeDBInstances(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBInstances operation. | |
EndDescribeDBLogFiles(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBLogFiles operation. | |
EndDescribeDBParameterGroups(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBParameterGroups operation. | |
EndDescribeDBParameters(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBParameters operation. | |
EndDescribeDBSecurityGroups(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBSecurityGroups operation. | |
EndDescribeDBSnapshotAttributes(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBSnapshotAttributes operation. | |
EndDescribeDBSnapshots(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBSnapshots operation. | |
EndDescribeDBSubnetGroups(IAsyncResult) | Finishes the asynchronous execution of the DescribeDBSubnetGroups operation. | |
EndDescribeEngineDefaultClusterParameters(IAsyncResult) | Finishes the asynchronous execution of the DescribeEngineDefaultClusterParameters operation. | |
EndDescribeEngineDefaultParameters(IAsyncResult) | Finishes the asynchronous execution of the DescribeEngineDefaultParameters operation. | |
EndDescribeEventCategories(IAsyncResult) | Finishes the asynchronous execution of the DescribeEventCategories operation. | |
EndDescribeEvents(IAsyncResult) | Finishes the asynchronous execution of the DescribeEvents operation. | |
EndDescribeEventSubscriptions(IAsyncResult) | Finishes the asynchronous execution of the DescribeEventSubscriptions operation. | |
EndDescribeOptionGroupOptions(IAsyncResult) | Finishes the asynchronous execution of the DescribeOptionGroupOptions operation. | |
EndDescribeOptionGroups(IAsyncResult) | Finishes the asynchronous execution of the DescribeOptionGroups operation. | |
EndDescribeOrderableDBInstanceOptions(IAsyncResult) | Finishes the asynchronous execution of the DescribeOrderableDBInstanceOptions operation. | |
EndDescribePendingMaintenanceActions(IAsyncResult) | Finishes the asynchronous execution of the DescribePendingMaintenanceActions operation. | |
EndDescribeReservedDBInstances(IAsyncResult) | Finishes the asynchronous execution of the DescribeReservedDBInstances operation. | |
EndDescribeReservedDBInstancesOfferings(IAsyncResult) | Finishes the asynchronous execution of the DescribeReservedDBInstancesOfferings operation. | |
EndDownloadDBLogFilePortion(IAsyncResult) | Finishes the asynchronous execution of the DownloadDBLogFilePortion operation. | |
EndFailoverDBCluster(IAsyncResult) | Finishes the asynchronous execution of the FailoverDBCluster operation. | |
EndListTagsForResource(IAsyncResult) | Finishes the asynchronous execution of the ListTagsForResource operation. | |
EndModifyDBCluster(IAsyncResult) | Finishes the asynchronous execution of the ModifyDBCluster operation. | |
EndModifyDBClusterParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the ModifyDBClusterParameterGroup operation. | |
EndModifyDBInstance(IAsyncResult) | Finishes the asynchronous execution of the ModifyDBInstance operation. | |
EndModifyDBParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the ModifyDBParameterGroup operation. | |
EndModifyDBSnapshotAttribute(IAsyncResult) | Finishes the asynchronous execution of the ModifyDBSnapshotAttribute operation. | |
EndModifyDBSubnetGroup(IAsyncResult) | Finishes the asynchronous execution of the ModifyDBSubnetGroup operation. | |
EndModifyEventSubscription(IAsyncResult) | Finishes the asynchronous execution of the ModifyEventSubscription operation. | |
EndModifyOptionGroup(IAsyncResult) | Finishes the asynchronous execution of the ModifyOptionGroup operation. | |
EndPromoteReadReplica(IAsyncResult) | Finishes the asynchronous execution of the PromoteReadReplica operation. | |
EndPurchaseReservedDBInstancesOffering(IAsyncResult) | Finishes the asynchronous execution of the PurchaseReservedDBInstancesOffering operation. | |
EndRebootDBInstance(IAsyncResult) | Finishes the asynchronous execution of the RebootDBInstance operation. | |
EndRemoveSourceIdentifierFromSubscription(IAsyncResult) | Finishes the asynchronous execution of the RemoveSourceIdentifierFromSubscription operation. | |
EndRemoveTagsFromResource(IAsyncResult) | Finishes the asynchronous execution of the RemoveTagsFromResource operation. | |
EndResetDBClusterParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the ResetDBClusterParameterGroup operation. | |
EndResetDBParameterGroup(IAsyncResult) | Finishes the asynchronous execution of the ResetDBParameterGroup operation. | |
EndRestoreDBClusterFromSnapshot(IAsyncResult) | Finishes the asynchronous execution of the RestoreDBClusterFromSnapshot operation. | |
EndRestoreDBClusterToPointInTime(IAsyncResult) | Finishes the asynchronous execution of the RestoreDBClusterToPointInTime operation. | |
EndRestoreDBInstanceFromDBSnapshot(IAsyncResult) | Finishes the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation. | |
EndRestoreDBInstanceToPointInTime(IAsyncResult) | Finishes the asynchronous execution of the RestoreDBInstanceToPointInTime operation. | |
EndRevokeDBSecurityGroupIngress(IAsyncResult) | Finishes the asynchronous execution of the RevokeDBSecurityGroupIngress operation. | |
FailoverDBCluster(FailoverDBClusterRequest) |
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance. Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
ListTagsForResource(ListTagsForResourceRequest) |
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources. |
|
ModifyDBCluster(ModifyDBClusterRequest) | Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. | |
ModifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest) |
Modifies the parameters of a DB cluster parameter group. To modify more than one
parameter, submit a list of the following: ParameterName , ParameterValue ,
and ApplyMethod . A maximum of 20 parameters can be modified in a single
request.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes
before creating your first DB cluster that uses that DB cluster parameter group as
the default parameter group. This allows Amazon RDS to fully complete the create action
before the parameter group is used as the default for a new DB cluster. This is especially
important for parameters that are critical when creating the default database for
a DB cluster, such as the character set for the default database defined by the |
|
ModifyDBInstance(ModifyDBInstanceRequest) | Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. | |
ModifyDBParameterGroup(ModifyDBParameterGroupRequest) |
Modifies the parameters of a DB parameter group. To modify more than one parameter,
submit a list of the following: ParameterName , ParameterValue ,
and ApplyMethod . A maximum of 20 parameters can be modified in a single
request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating
your first DB instance that uses that DB parameter group as the default parameter
group. This allows Amazon RDS to fully complete the modify action before the parameter
group is used as the default for a new DB instance. This is especially important for
parameters that are critical when creating the default database for a DB instance,
such as the character set for the default database defined by the |
|
ModifyDBSnapshotAttribute(ModifyDBSnapshotAttributeRequest) |
Adds an attribute and values to, or removes an attribute and values from a manual
DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API. If the manual DB snapshot is encrypted, it cannot be shared. |
|
ModifyDBSubnetGroup(ModifyDBSubnetGroupRequest) | Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. | |
ModifyEventSubscription(ModifyEventSubscriptionRequest) |
Modifies an existing RDS event notification subscription. Note that you cannot modify
the source identifiers using this call; to change source identifiers for a subscription,
use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription
calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. |
|
ModifyOptionGroup(ModifyOptionGroupRequest) | Modifies an existing option group. | |
PromoteReadReplica(PromoteReadReplicaRequest) |
Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings. |
|
PurchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest) | Purchases a reserved DB instance offering. | |
RebootDBInstance(RebootDBInstanceRequest) |
Rebooting a DB instance restarts the database engine service. A reboot also applies
to the DB instance any modifications to the associated DB parameter group that were
pending. Rebooting a DB instance results in a momentary outage of the instance, during
which the DB instance status is set to rebooting. If the RDS instance is configured
for MultiAZ, it is possible that the reboot will be conducted through a failover.
An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions. |
|
RemoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest) | Removes a source identifier from an existing RDS event notification subscription. | |
RemoveTagsFromResource(RemoveTagsFromResourceRequest) |
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources. |
|
ResetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest) |
Modifies the parameters of a DB cluster parameter group to the default value. To
reset specific parameters submit a list of the following: ParameterName
and ApplyMethod . To reset the entire DB cluster parameter group, specify
the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static
parameters are set to For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
ResetDBParameterGroup(ResetDBParameterGroupRequest) |
Modifies the parameters of a DB parameter group to the engine/system default value.
To reset specific parameters submit a list of the following: ParameterName
and ApplyMethod . To reset the entire DB parameter group, specify the
DBParameterGroup name and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static
parameters are set to pending-reboot to take effect on the next DB instance
restart or RebootDBInstance request.
|
|
RestoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest) |
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created
from the source DB cluster restore point with the same configuration as the original
source DB cluster, except that the new DB cluster is created with the default security
group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
RestoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest) |
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 more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. |
|
RestoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest) |
Creates a new DB instance from a DB snapshot. The target database is created from
the source database restore point with the most of original configuration with the
default security group and the default DB parameter group. By default, the new DB
instance is created as a single-AZ deployment except when the instance is a SQL Server
instance that has an option group that is associated with mirroring; in this case,
the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the |
|
RestoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest) |
Restores a DB instance to an arbitrary point in time. You can restore to any point
in time before the time identified by the LatestRestorableTime property. You can restore
to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. |
|
RevokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest) | Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1