AWS.RDS (aws-elixir v0.8.0) View Source

Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud.

It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

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

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

Amazon RDS API Reference

Amazon RDS User Guide

Link to this section Summary

Functions

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

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

Adds metadata tags to an Amazon RDS resource.

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

Enables ingress to a DBSecurityGroup using one of two forms of authorization.

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

Cancels an export task in progress that is exporting a snapshot to Amazon S3.

Copies the specified DB cluster parameter group.

Copies a snapshot of a DB cluster.

Copies the specified DB parameter group.

Copies the specified DB snapshot.

Copies the specified option group.

Creates a custom Availability Zone (AZ).

Creates a new Amazon Aurora DB cluster.

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

Creates a new DB cluster parameter group.

Creates a snapshot of a DB cluster.

Creates a new DB instance that acts as a read replica for an existing source DB instance.

Creates a snapshot of a DB instance.

Creates an RDS event notification subscription.

Creates an Aurora global database spread across multiple Amazon Web Services Regions.

Deletes a custom Availability Zone (AZ).

The DeleteDBCluster action deletes a previously provisioned DB cluster.

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

Deletes a specified DB cluster parameter group.

The DeleteDBInstance action deletes a previously provisioned DB instance.

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

Deletes a specified DB parameter group.

Deletes an existing DB proxy.

Deletes an RDS event notification subscription.

Deletes a global database cluster.

Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Deletes an existing option group.

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

Lists all of the attributes for a customer account.

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

Returns information about custom Availability Zones (AZs).

Returns information about backtracks for a DB cluster.

Returns information about endpoints for an Amazon Aurora DB cluster.

Returns a list of DBClusterParameterGroup descriptions.

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

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

Returns information about DB cluster snapshots.

Returns information about provisioned Aurora DB clusters.

Returns a list of the available DB engines.

Displays backups for both current and deleted instances.

Returns information about provisioned RDS instances.

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

Returns a list of DBParameterGroup descriptions.

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

Returns information about DB proxies.

Returns information about DB proxy endpoints.

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

Returns information about DBProxyTarget objects.

Returns a list of DBSecurityGroup descriptions.

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

Returns information about DB snapshots.

Returns a list of DBSubnetGroup descriptions.

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

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

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Lists all the subscription descriptions for a customer account.

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days.

Returns information about a snapshot export to Amazon S3.

Returns information about Aurora global database clusters.

Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Describes the available option groups.

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

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

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

Lists available reserved DB instance offerings.

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

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.

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

Forces a failover for a DB cluster.

Initiates the failover process for an Aurora global database (GlobalCluster).

Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.

Lists all tags on an Amazon RDS resource.

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

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

Modify a setting for an Amazon Aurora DB cluster.

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

Modifies the parameters of a DB cluster parameter group.

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

Modifies settings for a DB instance.

Modifies the parameters of a DB parameter group.

Changes the settings for an existing DB proxy.

Changes the settings for an existing DB proxy endpoint.

Modifies the properties of a DBProxyTargetGroup.

Updates a manual DB snapshot with a new engine version.

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

Modifies an existing DB subnet group.

Modifies an existing RDS event notification subscription.

Modify a setting for an Amazon Aurora global cluster.

Modifies an existing option group.

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

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

You might need to reboot your DB instance, usually for maintenance reasons.

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Detaches an Aurora secondary cluster from an Aurora global database cluster.

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

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

Removes metadata tags from an Amazon RDS resource.

Modifies the parameters of a DB cluster parameter group to the default value.

Modifies the parameters of a DB parameter group to the engine/system default value.

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.

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

Restores a DB cluster to an arbitrary point in time.

Creates a new DB instance from a DB snapshot.

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.

Restores a DB instance to an arbitrary point in time.

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.

Starts a database activity stream to monitor activity on the database.

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

Enables replication of automated backups to a different Amazon Web Services Region.

Starts an export of a snapshot to Amazon S3.

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

Stops an Amazon Aurora DB cluster.

Stops an Amazon RDS DB instance.

Stops automated backup replication for a DB instance.

Link to this section Functions

Link to this function

add_role_to_db_cluster(client, input, options \\ [])

View Source

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.

For more information, see Authorizing Amazon Aurora MySQL to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Link to this function

add_role_to_db_instance(client, input, options \\ [])

View Source

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

To add a role to a DB instance, the status of the DB instance must be available.

Link to this function

add_source_identifier_to_subscription(client, input, options \\ [])

View Source

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

Link to this function

add_tags_to_resource(client, input, options \\ [])

View Source

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.

Link to this function

apply_pending_maintenance_action(client, input, options \\ [])

View Source

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

Link to this function

authorize_db_security_group_ingress(client, input, options \\ [])

View Source

Enables ingress to a DBSecurityGroup using one of two forms of authorization.

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

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

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

Link to this function

backtrack_db_cluster(client, input, options \\ [])

View Source

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora MySQL DB clusters.

Link to this function

cancel_export_task(client, input, options \\ [])

View Source

Cancels an export task in progress that is exporting a snapshot to Amazon S3.

Any data that has already been written to the S3 bucket isn't removed.

Link to this function

copy_db_cluster_parameter_group(client, input, options \\ [])

View Source

Copies the specified DB cluster parameter group.

This action only applies to Aurora DB clusters.

Link to this function

copy_db_cluster_snapshot(client, input, options \\ [])

View Source

Copies a snapshot of a DB cluster.

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

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

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

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

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

* `KmsKeyId` - The Amazon Web Services KMS key

identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

* `DestinationRegion` - The name of the Amazon Web

Services Region that the DB cluster snapshot is to be created in.

* `SourceDBClusterSnapshotIdentifier` - The DB cluster

snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

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

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the 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 Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

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

This action only applies to Aurora DB clusters.

Link to this function

copy_db_parameter_group(client, input, options \\ [])

View Source

Copies the specified DB parameter group.

Link to this function

copy_db_snapshot(client, input, options \\ [])

View Source

Copies the specified DB snapshot.

The source DB snapshot must be in the available state.

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

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

Link to this function

copy_option_group(client, input, options \\ [])

View Source

Copies the specified option group.

Link to this function

create_custom_availability_zone(client, input, options \\ [])

View Source

Creates a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Link to this function

create_db_cluster(client, input, options \\ [])

View Source

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 or PostgreSQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

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

This action only applies to Aurora DB clusters.

Link to this function

create_db_cluster_endpoint(client, input, options \\ [])

View Source

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Link to this function

create_db_cluster_parameter_group(client, input, options \\ [])

View Source

Creates a new DB cluster parameter group.

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

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

create_db_cluster_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of a DB cluster.

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

This action only applies to Aurora DB clusters.

Link to this function

create_db_instance(client, input, options \\ [])

View Source

Creates a new DB instance.

Link to this function

create_db_instance_read_replica(client, input, options \\ [])

View Source

Creates a new DB instance that acts as a read replica for an existing source DB instance.

You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.

Your source DB instance must have backup retention enabled.

Link to this function

create_db_parameter_group(client, input, options \\ [])

View Source

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.

Link to this function

create_db_proxy(client, input, options \\ [])

View Source

Creates a new DB proxy.

Link to this function

create_db_proxy_endpoint(client, input, options \\ [])

View Source

Creates a DBProxyEndpoint.

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

Link to this function

create_db_security_group(client, input, options \\ [])

View Source

Creates a new DB security group.

DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

Link to this function

create_db_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of a DB instance.

The source DB instance must be in the available or storage-optimization state.

Link to this function

create_db_subnet_group(client, input, options \\ [])

View Source

Creates a new DB subnet group.

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

Link to this function

create_event_subscription(client, input, options \\ [])

View Source

Creates an RDS event notification subscription.

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

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

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

RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.

Link to this function

create_global_cluster(client, input, options \\ [])

View Source

Creates an Aurora global database spread across multiple Amazon Web Services Regions.

The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

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

This action only applies to Aurora DB clusters.

Link to this function

create_option_group(client, input, options \\ [])

View Source

Creates a new option group.

You can create up to 20 option groups.

Link to this function

delete_custom_availability_zone(client, input, options \\ [])

View Source

Deletes a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Link to this function

delete_db_cluster(client, input, options \\ [])

View Source

The DeleteDBCluster action deletes a previously provisioned DB cluster.

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

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

This action only applies to Aurora DB clusters.

Link to this function

delete_db_cluster_endpoint(client, input, options \\ [])

View Source

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Link to this function

delete_db_cluster_parameter_group(client, input, options \\ [])

View Source

Deletes a specified DB cluster parameter group.

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

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

This action only applies to Aurora DB clusters.

Link to this function

delete_db_cluster_snapshot(client, input, options \\ [])

View Source

Deletes a DB cluster snapshot.

If the snapshot is being copied, the copy operation is terminated.

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

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

This action only applies to Aurora DB clusters.

Link to this function

delete_db_instance(client, input, options \\ [])

View Source

The DeleteDBInstance action deletes a previously provisioned DB instance.

When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

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

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

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

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

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

Link to this function

delete_db_instance_automated_backup(client, input, options \\ [])

View Source

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

Link to this function

delete_db_parameter_group(client, input, options \\ [])

View Source

Deletes a specified DB parameter group.

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

Link to this function

delete_db_proxy(client, input, options \\ [])

View Source

Deletes an existing DB proxy.

Link to this function

delete_db_proxy_endpoint(client, input, options \\ [])

View Source

Deletes a DBProxyEndpoint.

Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

Link to this function

delete_db_security_group(client, input, options \\ [])

View Source

Deletes a DB security group.

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

Link to this function

delete_db_snapshot(client, input, options \\ [])

View Source

Deletes a DB snapshot.

If the snapshot is being copied, the copy operation is terminated.

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

Link to this function

delete_db_subnet_group(client, input, options \\ [])

View Source

Deletes a DB subnet group.

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

Link to this function

delete_event_subscription(client, input, options \\ [])

View Source

Deletes an RDS event notification subscription.

Link to this function

delete_global_cluster(client, input, options \\ [])

View Source

Deletes a global database cluster.

The primary and secondary clusters must already be detached or destroyed first.

This action only applies to Aurora DB clusters.

Link to this function

delete_installation_media(client, input, options \\ [])

View Source

Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Link to this function

delete_option_group(client, input, options \\ [])

View Source

Deletes an existing option group.

Link to this function

deregister_db_proxy_targets(client, input, options \\ [])

View Source

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

Link to this function

describe_account_attributes(client, input, options \\ [])

View Source

Lists all of the attributes for a customer account.

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

This command doesn't take any parameters.

Link to this function

describe_certificates(client, input, options \\ [])

View Source

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

Link to this function

describe_custom_availability_zones(client, input, options \\ [])

View Source

Returns information about custom Availability Zones (AZs).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Link to this function

describe_db_cluster_backtracks(client, input, options \\ [])

View Source

Returns information about backtracks for a DB cluster.

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

This action only applies to Aurora MySQL DB clusters.

Link to this function

describe_db_cluster_endpoints(client, input, options \\ [])

View Source

Returns information about endpoints for an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Link to this function

describe_db_cluster_parameter_groups(client, input, options \\ [])

View Source

Returns a list of DBClusterParameterGroup descriptions.

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

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

This action only applies to Aurora DB clusters.

Link to this function

describe_db_cluster_parameters(client, input, options \\ [])

View Source

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

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

This action only applies to Aurora DB clusters.

Link to this function

describe_db_cluster_snapshot_attributes(client, input, options \\ [])

View Source

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

describe_db_cluster_snapshots(client, input, options \\ [])

View Source

Returns information about DB cluster snapshots.

This API action supports pagination.

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

This action only applies to Aurora DB clusters.

Link to this function

describe_db_clusters(client, input, options \\ [])

View Source

Returns information about provisioned Aurora DB clusters.

This API supports pagination.

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

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

Link to this function

describe_db_engine_versions(client, input, options \\ [])

View Source

Returns a list of the available DB engines.

Link to this function

describe_db_instance_automated_backups(client, input, options \\ [])

View Source

Displays backups for both current and deleted instances.

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

All parameters are optional.

Link to this function

describe_db_instances(client, input, options \\ [])

View Source

Returns information about provisioned RDS instances.

This API supports pagination.

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

Link to this function

describe_db_log_files(client, input, options \\ [])

View Source

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

Link to this function

describe_db_parameter_groups(client, input, options \\ [])

View Source

Returns a list of DBParameterGroup descriptions.

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

Link to this function

describe_db_parameters(client, input, options \\ [])

View Source

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

Link to this function

describe_db_proxies(client, input, options \\ [])

View Source

Returns information about DB proxies.

Link to this function

describe_db_proxy_endpoints(client, input, options \\ [])

View Source

Returns information about DB proxy endpoints.

Link to this function

describe_db_proxy_target_groups(client, input, options \\ [])

View Source

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

Link to this function

describe_db_proxy_targets(client, input, options \\ [])

View Source

Returns information about DBProxyTarget objects.

This API supports pagination.

Link to this function

describe_db_security_groups(client, input, options \\ [])

View Source

Returns a list of DBSecurityGroup descriptions.

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

Link to this function

describe_db_snapshot_attributes(client, input, options \\ [])

View Source

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

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

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

Link to this function

describe_db_snapshots(client, input, options \\ [])

View Source

Returns information about DB snapshots.

This API action supports pagination.

Link to this function

describe_db_subnet_groups(client, input, options \\ [])

View Source

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.

Link to this function

describe_engine_default_cluster_parameters(client, input, options \\ [])

View Source

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

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

Link to this function

describe_engine_default_parameters(client, input, options \\ [])

View Source

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

Link to this function

describe_event_categories(client, input, options \\ [])

View Source

Displays a list of categories for all event source types, or, if specified, for a specified source type.

You can see a list of the event categories and source types in Events in the Amazon RDS User Guide.

Link to this function

describe_event_subscriptions(client, input, options \\ [])

View Source

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.

Link to this function

describe_events(client, input, options \\ [])

View Source

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days.

Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be obtained by providing the name as a parameter.

By default, the past hour of events are returned.

Link to this function

describe_export_tasks(client, input, options \\ [])

View Source

Returns information about a snapshot export to Amazon S3.

This API operation supports pagination.

Link to this function

describe_global_clusters(client, input, options \\ [])

View Source

Returns information about Aurora global database clusters.

This API supports pagination.

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

This action only applies to Aurora DB clusters.

Link to this function

describe_installation_media(client, input, options \\ [])

View Source

Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Link to this function

describe_option_group_options(client, input, options \\ [])

View Source

Describes all available options.

Link to this function

describe_option_groups(client, input, options \\ [])

View Source

Describes the available option groups.

Link to this function

describe_orderable_db_instance_options(client, input, options \\ [])

View Source

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

Link to this function

describe_pending_maintenance_actions(client, input, options \\ [])

View Source

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

Link to this function

describe_reserved_db_instances(client, input, options \\ [])

View Source

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

Link to this function

describe_reserved_db_instances_offerings(client, input, options \\ [])

View Source

Lists available reserved DB instance offerings.

Link to this function

describe_source_regions(client, input, options \\ [])

View Source

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

This API action supports pagination.

Link to this function

describe_valid_db_instance_modifications(client, input, options \\ [])

View Source

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.

You can use this information when you call ModifyDBInstance.

Link to this function

download_db_log_file_portion(client, input, options \\ [])

View Source

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

Link to this function

failover_db_cluster(client, input, options \\ [])

View Source

Forces a failover for a DB cluster.

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

failover_global_cluster(client, input, options \\ [])

View Source

Initiates the failover process for an Aurora global database (GlobalCluster).

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

Link to this function

import_installation_media(client, input, options \\ [])

View Source

Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Link to this function

modify_certificates(client, input, options \\ [])

View Source

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

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

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

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

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

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

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

Link to this function

modify_current_db_cluster_capacity(client, input, options \\ [])

View Source

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

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

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

modify_db_cluster(client, input, options \\ [])

View Source

Modify a setting for an Amazon Aurora DB cluster.

You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Link to this function

modify_db_cluster_endpoint(client, input, options \\ [])

View Source

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Link to this function

modify_db_cluster_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB cluster parameter group.

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

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

modify_db_cluster_snapshot_attribute(client, input, options \\ [])

View Source

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

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

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

modify_db_instance(client, input, options \\ [])

View Source

Modifies settings for a DB instance.

You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

Link to this function

modify_db_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB parameter group.

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

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

Link to this function

modify_db_proxy(client, input, options \\ [])

View Source

Changes the settings for an existing DB proxy.

Link to this function

modify_db_proxy_endpoint(client, input, options \\ [])

View Source

Changes the settings for an existing DB proxy endpoint.

Link to this function

modify_db_proxy_target_group(client, input, options \\ [])

View Source

Modifies the properties of a DBProxyTargetGroup.

Link to this function

modify_db_snapshot(client, input, options \\ [])

View Source

Updates a manual DB snapshot with a new engine version.

The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.

Link to this function

modify_db_snapshot_attribute(client, input, options \\ [])

View Source

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

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

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

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

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

Link to this function

modify_db_subnet_group(client, input, options \\ [])

View Source

Modifies an existing DB subnet group.

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

Link to this function

modify_event_subscription(client, input, options \\ [])

View Source

Modifies an existing RDS event notification subscription.

You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

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

Link to this function

modify_global_cluster(client, input, options \\ [])

View Source

Modify a setting for an Amazon Aurora global cluster.

You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Link to this function

modify_option_group(client, input, options \\ [])

View Source

Modifies an existing option group.

Link to this function

promote_read_replica(client, input, options \\ [])

View Source

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

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

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.

Link to this function

promote_read_replica_db_cluster(client, input, options \\ [])

View Source

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

This action only applies to Aurora DB clusters.

Link to this function

purchase_reserved_db_instances_offering(client, input, options \\ [])

View Source

Purchases a reserved DB instance offering.

Link to this function

reboot_db_instance(client, input, options \\ [])

View Source

You might need to reboot your DB instance, usually for maintenance reasons.

For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

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

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

Link to this function

register_db_proxy_targets(client, input, options \\ [])

View Source

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Link to this function

remove_from_global_cluster(client, input, options \\ [])

View Source

Detaches an Aurora secondary cluster from an Aurora global database cluster.

The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

This action only applies to Aurora DB clusters.

Link to this function

remove_role_from_db_cluster(client, input, options \\ [])

View Source

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.

For more information, see Authorizing Amazon Aurora MySQL to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Link to this function

remove_role_from_db_instance(client, input, options \\ [])

View Source

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

Link to this function

remove_source_identifier_from_subscription(client, input, options \\ [])

View Source

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

Link to this function

remove_tags_from_resource(client, input, options \\ [])

View Source

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Link to this function

reset_db_cluster_parameter_group(client, input, options \\ [])

View Source

Modifies the parameters of a DB cluster parameter group to the default value.

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

reset_db_parameter_group(client, input, options \\ [])

View Source

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.

Link to this function

restore_db_cluster_from_s3(client, input, options \\ [])

View Source

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.

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

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

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

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

Link to this function

restore_db_cluster_from_snapshot(client, input, options \\ [])

View Source

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

This action only applies to Aurora DB clusters.

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

restore_db_cluster_to_point_in_time(client, input, options \\ [])

View Source

Restores a DB cluster to an arbitrary point in time.

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

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

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

This action only applies to Aurora DB clusters.

Link to this function

restore_db_instance_from_db_snapshot(client, input, options \\ [])

View Source

Creates a new DB instance from a DB snapshot.

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

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

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

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

Link to this function

restore_db_instance_from_s3(client, input, options \\ [])

View Source

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.

You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

Link to this function

restore_db_instance_to_point_in_time(client, input, options \\ [])

View Source

Restores a DB instance to an arbitrary point in time.

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

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

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

Link to this function

revoke_db_security_group_ingress(client, input, options \\ [])

View Source

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

Link to this function

start_activity_stream(client, input, options \\ [])

View Source

Starts a database activity stream to monitor activity on the database.

For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Link to this function

start_db_cluster(client, input, options \\ [])

View Source

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Link to this function

start_db_instance(client, input, options \\ [])

View Source

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

Link to this function

start_db_instance_automated_backups_replication(client, input, options \\ [])

View Source

Enables replication of automated backups to a different Amazon Web Services Region.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Link to this function

start_export_task(client, input, options \\ [])

View Source

Starts an export of a snapshot to Amazon S3.

The provided IAM role must have access to the S3 bucket.

Link to this function

stop_activity_stream(client, input, options \\ [])

View Source

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Link to this function

stop_db_cluster(client, input, options \\ [])

View Source

Stops an Amazon Aurora DB cluster.

When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Link to this function

stop_db_instance(client, input, options \\ [])

View Source

Stops an Amazon RDS DB instance.

When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Link to this function

stop_db_instance_automated_backups_replication(client, input, options \\ [])

View Source

Stops automated backup replication for a DB instance.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.