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, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
rds(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- rds(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_role_to_db_cluster | Associates an Identity and Access Management (IAM) role with a DB cluster |
| add_role_to_db_instance | Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance |
| add_source_identifier_to_subscription | Adds a source identifier to an existing RDS event notification subscription |
| add_tags_to_resource | Adds metadata tags to an Amazon RDS resource |
| apply_pending_maintenance_action | Applies a pending maintenance action to a resource (for example, to a DB instance) |
| authorize_db_security_group_ingress | Enables ingress to a DBSecurityGroup using one of two forms of authorization |
| backtrack_db_cluster | Backtracks a DB cluster to a specific time, without creating a new DB cluster |
| build_auth_token | Return an authentication token for a database connection |
| cancel_export_task | Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3 |
| copy_db_cluster_parameter_group | Copies the specified DB cluster parameter group |
| copy_db_cluster_snapshot | Copies a snapshot of a DB cluster |
| copy_db_parameter_group | Copies the specified DB parameter group |
| copy_db_snapshot | Copies the specified DB snapshot |
| copy_option_group | Copies the specified option group |
| create_blue_green_deployment | Creates a blue/green deployment |
| create_custom_db_engine_version | Creates a custom DB engine version (CEV) |
| create_db_cluster | Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster |
| create_db_cluster_endpoint | Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster |
| create_db_cluster_parameter_group | Creates a new DB cluster parameter group |
| create_db_cluster_snapshot | Creates a snapshot of a DB cluster |
| create_db_instance | Creates a new DB instance |
| create_db_instance_read_replica | Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster |
| create_db_parameter_group | Creates a new DB parameter group |
| create_db_proxy | Creates a new DB proxy |
| create_db_proxy_endpoint | Creates a DBProxyEndpoint |
| create_db_security_group | Creates a new DB security group |
| create_db_snapshot | Creates a snapshot of a DB instance |
| create_db_subnet_group | Creates a new DB subnet group |
| create_event_subscription | Creates an RDS event notification subscription |
| create_global_cluster | Creates an Aurora global database spread across multiple Amazon Web Services Regions |
| create_integration | Creates a zero-ETL integration with Amazon Redshift |
| create_option_group | Creates a new option group |
| create_tenant_database | Creates a tenant database in a DB instance that uses the multi-tenant configuration |
| delete_blue_green_deployment | Deletes a blue/green deployment |
| delete_custom_db_engine_version | Deletes a custom engine version |
| delete_db_cluster | The DeleteDBCluster action deletes a previously provisioned DB cluster |
| delete_db_cluster_automated_backup | Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups |
| delete_db_cluster_endpoint | Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster |
| delete_db_cluster_parameter_group | Deletes a specified DB cluster parameter group |
| delete_db_cluster_snapshot | Deletes a DB cluster snapshot |
| delete_db_instance | Deletes a previously provisioned DB instance |
| delete_db_instance_automated_backup | Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups |
| delete_db_parameter_group | Deletes a specified DB parameter group |
| delete_db_proxy | Deletes an existing DB proxy |
| delete_db_proxy_endpoint | Deletes a DBProxyEndpoint |
| delete_db_security_group | Deletes a DB security group |
| delete_db_snapshot | Deletes a DB snapshot |
| delete_db_subnet_group | Deletes a DB subnet group |
| delete_event_subscription | Deletes an RDS event notification subscription |
| delete_global_cluster | Deletes a global database cluster |
| delete_integration | Deletes a zero-ETL integration with Amazon Redshift |
| delete_option_group | Deletes an existing option group |
| delete_tenant_database | Deletes a tenant database from your DB instance |
| deregister_db_proxy_targets | Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup |
| describe_account_attributes | Lists all of the attributes for a customer account |
| describe_blue_green_deployments | Describes one or more blue/green deployments |
| describe_certificates | Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account |
| describe_db_cluster_automated_backups | Displays backups for both current and deleted DB clusters |
| describe_db_cluster_backtracks | Returns information about backtracks for a DB cluster |
| describe_db_cluster_endpoints | Returns information about endpoints for an Amazon Aurora DB cluster |
| describe_db_cluster_parameter_groups | Returns a list of DBClusterParameterGroup descriptions |
| describe_db_cluster_parameters | Returns the detailed parameter list for a particular DB cluster parameter group |
| describe_db_clusters | Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters |
| describe_db_cluster_snapshot_attributes | Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot |
| describe_db_cluster_snapshots | Returns information about DB cluster snapshots |
| describe_db_engine_versions | Describes the properties of specific versions of DB engines |
| describe_db_instance_automated_backups | Displays backups for both current and deleted instances |
| describe_db_instances | Describes provisioned RDS instances |
| describe_db_log_files | Returns a list of DB log files for the DB instance |
| describe_db_parameter_groups | Returns a list of DBParameterGroup descriptions |
| describe_db_parameters | Returns the detailed parameter list for a particular DB parameter group |
| describe_db_proxies | Returns information about DB proxies |
| describe_db_proxy_endpoints | Returns information about DB proxy endpoints |
| describe_db_proxy_target_groups | Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures |
| describe_db_proxy_targets | Returns information about DBProxyTarget objects |
| describe_db_recommendations | Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups |
| describe_db_security_groups | Returns a list of DBSecurityGroup descriptions |
| describe_db_snapshot_attributes | Returns a list of DB snapshot attribute names and values for a manual DB snapshot |
| describe_db_snapshots | Returns information about DB snapshots |
| describe_db_snapshot_tenant_databases | Describes the tenant databases that exist in a DB snapshot |
| describe_db_subnet_groups | Returns a list of DBSubnetGroup descriptions |
| describe_engine_default_cluster_parameters | Returns the default engine and system parameter information for the cluster database engine |
| describe_engine_default_parameters | Returns the default engine and system parameter information for the specified database engine |
| describe_event_categories | Displays a list of categories for all event source types, or, if specified, for a specified source type |
| describe_events | Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days |
| describe_event_subscriptions | Lists all the subscription descriptions for a customer account |
| describe_export_tasks | Returns information about a snapshot or cluster export to Amazon S3 |
| describe_global_clusters | Returns information about Aurora global database clusters |
| describe_integrations | Describe one or more zero-ETL integrations with Amazon Redshift |
| describe_option_group_options | Describes all available options for the specified engine |
| describe_option_groups | Describes the available option groups |
| describe_orderable_db_instance_options | Describes the orderable DB instance options for a specified DB engine |
| describe_pending_maintenance_actions | Returns a list of resources (for example, DB instances) that have at least one pending maintenance action |
| describe_reserved_db_instances | Returns information about reserved DB instances for this account, or about a specified reserved DB instance |
| describe_reserved_db_instances_offerings | Lists available reserved DB instance offerings |
| describe_source_regions | 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 |
| describe_tenant_databases | Describes the tenant databases in a DB instance that uses the multi-tenant configuration |
| describe_valid_db_instance_modifications | You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance |
| disable_http_endpoint | Disables the HTTP endpoint for the specified DB cluster |
| download_db_log_file_portion | Downloads all or a portion of the specified log file, up to 1 MB in size |
| enable_http_endpoint | Enables the HTTP endpoint for the DB cluster |
| failover_db_cluster | Forces a failover for a DB cluster |
| failover_global_cluster | Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database |
| list_tags_for_resource | Lists all tags on an Amazon RDS resource |
| modify_activity_stream | Changes the audit policy state of a database activity stream to either locked (default) or unlocked |
| modify_certificates | Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override |
| modify_current_db_cluster_capacity | Set the capacity of an Aurora Serverless v1 DB cluster to a specific value |
| modify_custom_db_engine_version | Modifies the status of a custom engine version (CEV) |
| modify_db_cluster | Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster |
| modify_db_cluster_endpoint | Modifies the properties of an endpoint in an Amazon Aurora DB cluster |
| modify_db_cluster_parameter_group | Modifies the parameters of a DB cluster parameter group |
| modify_db_cluster_snapshot_attribute | Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot |
| modify_db_instance | Modifies settings for a DB instance |
| modify_db_parameter_group | Modifies the parameters of a DB parameter group |
| modify_db_proxy | Changes the settings for an existing DB proxy |
| modify_db_proxy_endpoint | Changes the settings for an existing DB proxy endpoint |
| modify_db_proxy_target_group | Modifies the properties of a DBProxyTargetGroup |
| modify_db_recommendation | Updates the recommendation status and recommended action status for the specified recommendation |
| modify_db_snapshot | Updates a manual DB snapshot with a new engine version |
| modify_db_snapshot_attribute | Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot |
| modify_db_subnet_group | Modifies an existing DB subnet group |
| modify_event_subscription | Modifies an existing RDS event notification subscription |
| modify_global_cluster | Modifies a setting for an Amazon Aurora global database cluster |
| modify_option_group | Modifies an existing option group |
| modify_tenant_database | Modifies an existing tenant database in a DB instance |
| promote_read_replica | Promotes a read replica DB instance to a standalone DB instance |
| promote_read_replica_db_cluster | Promotes a read replica DB cluster to a standalone DB cluster |
| purchase_reserved_db_instances_offering | Purchases a reserved DB instance offering |
| reboot_db_cluster | You might need to reboot your DB cluster, usually for maintenance reasons |
| reboot_db_instance | You might need to reboot your DB instance, usually for maintenance reasons |
| register_db_proxy_targets | Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup |
| remove_from_global_cluster | Detaches an Aurora secondary cluster from an Aurora global database cluster |
| remove_role_from_db_cluster | Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster |
| remove_role_from_db_instance | Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance |
| remove_source_identifier_from_subscription | Removes a source identifier from an existing RDS event notification subscription |
| remove_tags_from_resource | Removes metadata tags from an Amazon RDS resource |
| reset_db_cluster_parameter_group | Modifies the parameters of a DB cluster parameter group to the default value |
| reset_db_parameter_group | Modifies the parameters of a DB parameter group to the engine/system default value |
| restore_db_cluster_from_s3 | Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket |
| restore_db_cluster_from_snapshot | Creates a new DB cluster from a DB snapshot or DB cluster snapshot |
| restore_db_cluster_to_point_in_time | Restores a DB cluster to an arbitrary point in time |
| restore_db_instance_from_db_snapshot | Creates a new DB instance from a DB snapshot |
| restore_db_instance_from_s3 | Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files |
| restore_db_instance_to_point_in_time | Restores a DB instance to an arbitrary point in time |
| revoke_db_security_group_ingress | Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups |
| start_activity_stream | Starts a database activity stream to monitor activity on the database |
| start_db_cluster | Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation |
| start_db_instance | Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation |
| start_db_instance_automated_backups_replication | Enables replication of automated backups to a different Amazon Web Services Region |
| start_export_task | Starts an export of DB snapshot or DB cluster data to Amazon S3 |
| stop_activity_stream | Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation |
| stop_db_cluster | Stops an Amazon Aurora DB cluster |
| stop_db_instance | Stops an Amazon RDS DB instance |
| stop_db_instance_automated_backups_replication | Stops automated backup replication for a DB instance |
| switchover_blue_green_deployment | Switches over a blue/green deployment |
| switchover_global_cluster | Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster |
| switchover_read_replica | Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database |
if (FALSE) {
svc <- rds()
svc$add_role_to_db_cluster(
Foo = 123
)
}
Run the code above in your browser using DataLab