AWS SDK Version 3 for .NET
API Reference

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.

Interface for accessing RDS Amazon Relational Database Service

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

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

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

Amazon RDS API Reference

Amazon RDS User Guide

Inheritance Hierarchy

Amazon.RDS.IAmazonRDS

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonRDS
         IAmazonService, IDisposable

The IAmazonRDS type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddRoleToDBCluster(AddRoleToDBClusterRequest)

Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

Public Method AddRoleToDBClusterAsync(AddRoleToDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the AddRoleToDBCluster operation.

Public Method AddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest)

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

Public Method AddSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the AddSourceIdentifierToSubscription operation.

Public Method 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.

Public Method AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AddTagsToResource operation.

Public Method ApplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest)

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

Public Method ApplyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest, CancellationToken)

Initiates the asynchronous execution of the ApplyPendingMaintenanceAction operation.

Public Method 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).

You cannot authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

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

Public Method AuthorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest, CancellationToken)

Initiates the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation.

Public Method CopyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest)

Copies the specified DB cluster parameter group.

Public Method CopyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CopyDBClusterParameterGroup operation.

Public Method CopyDBClusterSnapshot(CopyDBClusterSnapshotRequest)

Copies a snapshot of a DB cluster.

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

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

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

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot will be copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

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

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

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

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.

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

Public Method CopyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the CopyDBClusterSnapshot operation.

Public Method CopyDBParameterGroup(CopyDBParameterGroupRequest)

Copies the specified DB parameter group.

Public Method CopyDBParameterGroupAsync(CopyDBParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CopyDBParameterGroup operation.

Public Method CopyDBSnapshot(CopyDBSnapshotRequest)

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

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

You cannot copy an encrypted, shared DB snapshot from one AWS Region to another.

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

Public Method CopyDBSnapshotAsync(CopyDBSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the CopyDBSnapshot operation.

Public Method CopyOptionGroup(CopyOptionGroupRequest)

Copies the specified option group.

Public Method CopyOptionGroupAsync(CopyOptionGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CopyOptionGroup operation.

Public Method CreateDBCluster(CreateDBClusterRequest)

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

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

Public Method CreateDBClusterAsync(CreateDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBCluster operation.

Public Method 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 character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

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

Public Method CreateDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBClusterParameterGroup operation.

Public Method 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.

Public Method CreateDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBClusterSnapshot operation.

Public Method CreateDBInstance(CreateDBInstanceRequest)

Creates a new DB instance.

Public Method CreateDBInstanceAsync(CreateDBInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBInstance operation.

Public Method CreateDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest)

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL.

Amazon Aurora does not support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

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.

For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.

Public Method CreateDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBInstanceReadReplica operation.

Public Method 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 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.

Public Method CreateDBParameterGroupAsync(CreateDBParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBParameterGroup operation.

Public Method CreateDBSecurityGroup(CreateDBSecurityGroupRequest)

Creates a new DB security group. DB security groups control access to a DB instance.

Public Method CreateDBSecurityGroupAsync(CreateDBSecurityGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBSecurityGroup operation.

Public Method CreateDBSnapshot(CreateDBSnapshotRequest)

Creates a DBSnapshot. The source DBInstance must be in "available" state.

Public Method CreateDBSnapshotAsync(CreateDBSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBSnapshot operation.

Public Method CreateDBSubnetGroup(CreateDBSubnetGroupRequest)

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

Public Method CreateDBSubnetGroupAsync(CreateDBSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDBSubnetGroup operation.

Public Method 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.

Public Method CreateEventSubscriptionAsync(CreateEventSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateEventSubscription operation.

Public Method CreateOptionGroup(CreateOptionGroupRequest)

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

Public Method CreateOptionGroupAsync(CreateOptionGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateOptionGroup operation.

Public Method DeleteDBCluster(DeleteDBClusterRequest)

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 cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

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

Public Method DeleteDBClusterAsync(DeleteDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBCluster operation.

Public Method 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.

Public Method DeleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBClusterParameterGroup operation.

Public Method DeleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest)

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

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

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

Public Method DeleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBClusterSnapshot operation.

Public Method DeleteDBInstance(DeleteDBInstanceRequest)

The DeleteDBInstance action deletes a previously provisioned DB instance. 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 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 cannot be canceled or reverted once submitted.

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

If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot 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.

Public Method DeleteDBInstanceAsync(DeleteDBInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBInstance operation.

Public Method DeleteDBParameterGroup(DeleteDBParameterGroupRequest)

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

Public Method DeleteDBParameterGroupAsync(DeleteDBParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBParameterGroup operation.

Public Method DeleteDBSecurityGroup(DeleteDBSecurityGroupRequest)

Deletes a DB security group.

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

Public Method DeleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBSecurityGroup operation.

Public Method DeleteDBSnapshot(DeleteDBSnapshotRequest)

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

The DBSnapshot must be in the available state to be deleted.

Public Method DeleteDBSnapshotAsync(DeleteDBSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBSnapshot operation.

Public Method DeleteDBSubnetGroup(DeleteDBSubnetGroupRequest)

Deletes a DB subnet group.

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

Public Method DeleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDBSubnetGroup operation.

Public Method DeleteEventSubscription(DeleteEventSubscriptionRequest)

Deletes an RDS event notification subscription.

Public Method DeleteEventSubscriptionAsync(DeleteEventSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEventSubscription operation.

Public Method DeleteOptionGroup(DeleteOptionGroupRequest)

Deletes an existing option group.

Public Method DeleteOptionGroupAsync(DeleteOptionGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteOptionGroup operation.

Public Method 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.

Public Method 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.

Public Method DescribeAccountAttributesAsync(CancellationToken)

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.

Public Method DescribeAccountAttributesAsync(DescribeAccountAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAccountAttributes operation.

Public Method DescribeCertificates(DescribeCertificatesRequest)

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

Public Method DescribeCertificatesAsync(DescribeCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCertificates operation.

Public Method 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.

Public Method DescribeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBClusterParameterGroups operation.

Public Method 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.

Public Method DescribeDBClusterParametersAsync(DescribeDBClusterParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBClusterParameters operation.

Public Method 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.

Public Method DescribeDBClustersAsync(DescribeDBClustersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBClusters operation.

Public Method DescribeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest)

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

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

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

Public Method DescribeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBClusterSnapshotAttributes operation.

Public Method DescribeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest)

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

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

Public Method DescribeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBClusterSnapshots operation.

Public Method DescribeDBEngineVersions()

Returns a list of the available DB engines.

Public Method DescribeDBEngineVersions(DescribeDBEngineVersionsRequest)

Returns a list of the available DB engines.

Public Method DescribeDBEngineVersionsAsync(CancellationToken)

Returns a list of the available DB engines.

Public Method DescribeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBEngineVersions operation.

Public Method DescribeDBInstances()

Returns information about provisioned RDS instances. This API supports pagination.

Public Method DescribeDBInstances(DescribeDBInstancesRequest)

Returns information about provisioned RDS instances. This API supports pagination.

Public Method DescribeDBInstancesAsync(DescribeDBInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBInstances operation.

Public Method DescribeDBInstancesAsync(CancellationToken)

Returns information about provisioned RDS instances. This API supports pagination.

Public Method DescribeDBLogFiles(DescribeDBLogFilesRequest)

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

Public Method DescribeDBLogFilesAsync(DescribeDBLogFilesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBLogFiles operation.

Public Method 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.

Public Method 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.

Public Method DescribeDBParameterGroupsAsync(CancellationToken)

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

Public Method DescribeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBParameterGroups operation.

Public Method DescribeDBParameters(DescribeDBParametersRequest)

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

Public Method DescribeDBParametersAsync(DescribeDBParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBParameters operation.

Public Method 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.

Public Method 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.

Public Method DescribeDBSecurityGroupsAsync(CancellationToken)

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

Public Method DescribeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBSecurityGroups operation.

Public Method DescribeDBSnapshotAttributes(DescribeDBSnapshotAttributesRequest)

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

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

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

Public Method DescribeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBSnapshotAttributes operation.

Public Method DescribeDBSnapshots()

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

Public Method DescribeDBSnapshots(DescribeDBSnapshotsRequest)

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

Public Method DescribeDBSnapshotsAsync(CancellationToken)

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

Public Method DescribeDBSnapshotsAsync(DescribeDBSnapshotsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBSnapshots operation.

Public Method 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.

Public Method 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.

Public Method DescribeDBSubnetGroupsAsync(CancellationToken)

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.

Public Method DescribeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDBSubnetGroups operation.

Public Method 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.

Public Method DescribeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEngineDefaultClusterParameters operation.

Public Method DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest)

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

Public Method DescribeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation.

Public Method 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.

Public Method 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.

Public Method DescribeEventCategoriesAsync(CancellationToken)

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.

Public Method DescribeEventCategoriesAsync(DescribeEventCategoriesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventCategories operation.

Public Method 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.

Public Method 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.

Public Method DescribeEventsAsync(CancellationToken)

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.

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEvents operation.

Public Method 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.

Public Method 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.

Public Method DescribeEventSubscriptionsAsync(CancellationToken)

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.

Public Method DescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventSubscriptions operation.

Public Method DescribeOptionGroupOptions(DescribeOptionGroupOptionsRequest)

Describes all available options.

Public Method DescribeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOptionGroupOptions operation.

Public Method DescribeOptionGroups()

Describes the available option groups.

Public Method DescribeOptionGroups(DescribeOptionGroupsRequest)

Describes the available option groups.

Public Method DescribeOptionGroupsAsync(CancellationToken)

Describes the available option groups.

Public Method DescribeOptionGroupsAsync(DescribeOptionGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOptionGroups operation.

Public Method DescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest)

Returns a list of orderable DB instance options for the specified engine.

Public Method DescribeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOrderableDBInstanceOptions operation.

Public Method DescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)

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

Public Method DescribePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePendingMaintenanceActions operation.

Public Method DescribeReservedDBInstances()

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

Public Method DescribeReservedDBInstances(DescribeReservedDBInstancesRequest)

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

Public Method DescribeReservedDBInstancesAsync(CancellationToken)

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

Public Method DescribeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeReservedDBInstances operation.

Public Method DescribeReservedDBInstancesOfferings()

Lists available reserved DB instance offerings.

Public Method DescribeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest)

Lists available reserved DB instance offerings.

Public Method DescribeReservedDBInstancesOfferingsAsync(CancellationToken)

Lists available reserved DB instance offerings.

Public Method DescribeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeReservedDBInstancesOfferings operation.

Public Method DescribeSourceRegions(DescribeSourceRegionsRequest)

Returns a list of the source AWS regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

Public Method DescribeSourceRegionsAsync(DescribeSourceRegionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSourceRegions operation.

Public Method DownloadDBLogFilePortion(DownloadDBLogFilePortionRequest)

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

Public Method DownloadDBLogFilePortionAsync(DownloadDBLogFilePortionRequest, CancellationToken)

Initiates the asynchronous execution of the DownloadDBLogFilePortion operation.

Public Method FailoverDBCluster(FailoverDBClusterRequest)

Forces a failover for a DB cluster.

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

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

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

Public Method FailoverDBClusterAsync(FailoverDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the FailoverDBCluster operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all tags on an Amazon RDS resource.

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

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method 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.

Public Method ModifyDBClusterAsync(ModifyDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBCluster operation.

Public Method 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 character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Public Method ModifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBClusterParameterGroup operation.

Public Method ModifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest)

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

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

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

Public Method ModifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBClusterSnapshotAttribute operation.

Public Method ModifyDBInstance(ModifyDBInstanceRequest)

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.

Public Method ModifyDBInstanceAsync(ModifyDBInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBInstance operation.

Public Method 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 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.

Public Method ModifyDBParameterGroupAsync(ModifyDBParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBParameterGroup operation.

Public Method ModifyDBSnapshot(ModifyDBSnapshotRequest)

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

Public Method ModifyDBSnapshotAsync(ModifyDBSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBSnapshot operation.

Public Method 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 restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

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

Public Method ModifyDBSnapshotAttributeAsync(ModifyDBSnapshotAttributeRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBSnapshotAttribute operation.

Public Method ModifyDBSubnetGroup(ModifyDBSubnetGroupRequest)

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

Public Method ModifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyDBSubnetGroup operation.

Public Method 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.

Public Method ModifyEventSubscriptionAsync(ModifyEventSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyEventSubscription operation.

Public Method ModifyOptionGroup(ModifyOptionGroupRequest)

Modifies an existing option group.

Public Method ModifyOptionGroupAsync(ModifyOptionGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyOptionGroup operation.

Public Method 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.

Public Method PromoteReadReplicaAsync(PromoteReadReplicaRequest, CancellationToken)

Initiates the asynchronous execution of the PromoteReadReplica operation.

Public Method PromoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest)

Promotes a Read Replica DB cluster to a standalone DB cluster.

Public Method PromoteReadReplicaDBClusterAsync(PromoteReadReplicaDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the PromoteReadReplicaDBCluster operation.

Public Method PurchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest)

Purchases a reserved DB instance offering.

Public Method PurchaseReservedDBInstancesOfferingAsync(PurchaseReservedDBInstancesOfferingRequest, CancellationToken)

Initiates the asynchronous execution of the PurchaseReservedDBInstancesOffering operation.

Public Method 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.

Public Method RebootDBInstanceAsync(RebootDBInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the RebootDBInstance operation.

Public Method RemoveRoleFromDBCluster(RemoveRoleFromDBClusterRequest)

Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

Public Method RemoveRoleFromDBClusterAsync(RemoveRoleFromDBClusterRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveRoleFromDBCluster operation.

Public Method RemoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest)

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

Public Method RemoveSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveSourceIdentifierFromSubscription operation.

Public Method RemoveTagsFromResource(RemoveTagsFromResourceRequest)

Removes metadata tags from an Amazon RDS resource.

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

Public Method RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTagsFromResource operation.

Public Method 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 pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

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

Public Method ResetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ResetDBClusterParameterGroup operation.

Public Method ResetDBParameterGroup(ResetDBParameterGroupRequest)

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.

Public Method ResetDBParameterGroupAsync(ResetDBParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ResetDBParameterGroup operation.

Public Method RestoreDBClusterFromS3(RestoreDBClusterFromS3Request)

Creates an Amazon Aurora DB cluster from 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.

Public Method RestoreDBClusterFromS3Async(RestoreDBClusterFromS3Request, CancellationToken)

Initiates the asynchronous execution of the RestoreDBClusterFromS3 operation.

Public Method RestoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest)

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

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, 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.

Public Method RestoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the RestoreDBClusterFromSnapshot operation.

Public Method 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.

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

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

Public Method RestoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest, CancellationToken)

Initiates the asynchronous execution of the RestoreDBClusterToPointInTime operation.

Public Method 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 DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Public Method RestoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation.

Public Method 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.

Public Method RestoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest, CancellationToken)

Initiates the asynchronous execution of the RestoreDBInstanceToPointInTime operation.

Public Method 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).

Public Method RevokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest, CancellationToken)

Initiates the asynchronous execution of the RevokeDBSecurityGroupIngress operation.

Public Method StartDBInstance(StartDBInstanceRequest)

Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.

Public Method StartDBInstanceAsync(StartDBInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the StartDBInstance operation.

Public Method StopDBInstance(StopDBInstanceRequest)

Stops a 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 and Starting a DB instance in the AWS RDS user guide.

Public Method StopDBInstanceAsync(StopDBInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the StopDBInstance operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms