logo
Expand description

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

If you’re using the service, you’re probably looking for RdsClient and Rds.

Structs

Data returned by the DescribeAccountAttributes action.

Describes a quota for an Amazon Web Services account.

The following are account quotas:

  • AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.

  • AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.

  • CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.

  • DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.

  • DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.

  • DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.

  • DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.

  • DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.

  • DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.

  • DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.

  • DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.

  • EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.

  • ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.

  • ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.

  • OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.

  • ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.

  • ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.

  • SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.

For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

A CA certificate for an Amazon Web Services account.

Data returned by the DescribeCertificates action.

This data type is used as a response element in the action DescribeDBEngineVersions.

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

A custom Availability Zone (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.

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

This data type is used as a response element in the DescribeDBClusterBacktracks action.

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

Contains information about an instance that is part of a DB cluster.

Contains the result of a successful invocation of the DescribeDBClusters action.

Contains status information for a DB cluster option group.

Contains the details of an Amazon RDS DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

This data type is used as a response element in the action DescribeDBEngineVersions.

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

Contains the result of a successful invocation of the DescribeDBInstances action.

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

Provides a list of status information for a DB instance.

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

Contains the result of a successful invocation of the DescribeDBParameters action.

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

The status of the DB parameter group.

This data type is used as a response element in the following actions:

  • CreateDBInstance

  • CreateDBInstanceReadReplica

  • DeleteDBInstance

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

Contains the details for an Amazon RDS DB security group.

This data type is used as a response element in the DescribeDBSecurityGroups action.

This data type is used as a response element in the following actions:

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceToPointInTime

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

Contains the result of a successful invocation of the DescribeDBSnapshots action.

Contains the details of an Amazon RDS DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

Parameter input for DescribeDBInstanceAutomatedBackups.

This data type is used as a response element to DescribeDBLogFiles.

The response from a call to DescribeDBLogFiles.

An Active Directory Domain membership record associated with the DB instance or cluster.

A range of double values.

This data type is used as a response element to DownloadDBLogFilePortion.

This data type is used as a response element in the following actions:

  • AuthorizeDBSecurityGroupIngress

  • DescribeDBSecurityGroups

  • RevokeDBSecurityGroupIngress

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

  • CreateDBInstance

  • DescribeDBInstances

  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

This data type is used as a response element in the DescribeEvents action.

Contains the results of a successful invocation of the DescribeEventCategories operation.

Data returned from the DescribeEventCategories operation.

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

Data returned by the DescribeEventSubscriptions action.

Contains the result of a successful invocation of the DescribeEvents action.

Contains the details of a snapshot export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks action.

Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribePendingMaintenanceActions

A data type representing an Aurora global database.

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

This data type is used as a response element in the DescribeDBSecurityGroups action.

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

Contains the cause of an installation media failure. Installation media is used for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

The minimum DB engine version required for each corresponding allowed value for an option setting.

A list of all available options

Provides information on the option groups the DB instance is a member of.

Available option.

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

List of option groups.

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

Provides information about a pending maintenance action for a resource.

Data returned from the DescribePendingMaintenanceActions action.

This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

  • CreateDBInstance

  • ModifyDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceFromS3

  • RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

  • DescribeDBInstances

  • DescribeDBSnapshots

  • DescribeValidDBInstanceModifications

If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:

  • You are accessing an Oracle DB instance.

  • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

  • The current number CPU cores and threads is set to a non-default value.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

Option details.

A range of integer values.

A client for the Amazon RDS API.

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

Describes the pending maintenance actions for a resource.

Earliest and latest time an instance can be restored to:

Contains the scaling configuration of an Aurora Serverless DB cluster.

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

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

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

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

Contains the result of a successful invocation of the DescribeSourceRegions action.

This data type is used as a response element for the DescribeDBSubnetGroups operation.

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

Information about the connection health of an RDS Proxy target.

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

The version of the database engine that a DB instance can be upgraded to.

Specifies the details of authentication used by a proxy to log in as a specific database user.

Returns the details of authentication used by a proxy to log in as a specific database user.

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

This data type is used as a response element for queries on VPC security group membership.

Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

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

Enums

Errors returned by AddRoleToDBCluster

Errors returned by AddRoleToDBInstance

Errors returned by AddSourceIdentifierToSubscription

Errors returned by AddTagsToResource

Errors returned by ApplyPendingMaintenanceAction

Errors returned by AuthorizeDBSecurityGroupIngress

Errors returned by BacktrackDBCluster

Errors returned by CancelExportTask

Errors returned by CopyDBClusterParameterGroup

Errors returned by CopyDBClusterSnapshot

Errors returned by CopyDBParameterGroup

Errors returned by CopyDBSnapshot

Errors returned by CopyOptionGroup

Errors returned by CreateCustomAvailabilityZone

Errors returned by CreateDBClusterEndpoint

Errors returned by CreateDBCluster

Errors returned by CreateDBClusterParameterGroup

Errors returned by CreateDBClusterSnapshot

Errors returned by CreateDBInstance

Errors returned by CreateDBInstanceReadReplica

Errors returned by CreateDBParameterGroup

Errors returned by CreateDBProxyEndpoint

Errors returned by CreateDBProxy

Errors returned by CreateDBSecurityGroup

Errors returned by CreateDBSnapshot

Errors returned by CreateDBSubnetGroup

Errors returned by CreateEventSubscription

Errors returned by CreateGlobalCluster

Errors returned by CreateOptionGroup

Errors returned by DeleteCustomAvailabilityZone

Errors returned by DeleteDBClusterEndpoint

Errors returned by DeleteDBCluster

Errors returned by DeleteDBClusterParameterGroup

Errors returned by DeleteDBClusterSnapshot

Errors returned by DeleteDBInstanceAutomatedBackup

Errors returned by DeleteDBInstance

Errors returned by DeleteDBParameterGroup

Errors returned by DeleteDBProxyEndpoint

Errors returned by DeleteDBProxy

Errors returned by DeleteDBSecurityGroup

Errors returned by DeleteDBSnapshot

Errors returned by DeleteDBSubnetGroup

Errors returned by DeleteEventSubscription

Errors returned by DeleteGlobalCluster

Errors returned by DeleteInstallationMedia

Errors returned by DeleteOptionGroup

Errors returned by DeregisterDBProxyTargets

Errors returned by DescribeAccountAttributes

Errors returned by DescribeCertificates

Errors returned by DescribeCustomAvailabilityZones

Errors returned by DescribeDBClusterBacktracks

Errors returned by DescribeDBClusterEndpoints

Errors returned by DescribeDBClusterParameterGroups

Errors returned by DescribeDBClusterParameters

Errors returned by DescribeDBClusterSnapshotAttributes

Errors returned by DescribeDBClusterSnapshots

Errors returned by DescribeDBClusters

Errors returned by DescribeDBEngineVersions

Errors returned by DescribeDBInstanceAutomatedBackups

Errors returned by DescribeDBInstances

Errors returned by DescribeDBLogFiles

Errors returned by DescribeDBParameterGroups

Errors returned by DescribeDBParameters

Errors returned by DescribeDBProxies

Errors returned by DescribeDBProxyEndpoints

Errors returned by DescribeDBProxyTargetGroups

Errors returned by DescribeDBProxyTargets

Errors returned by DescribeDBSecurityGroups

Errors returned by DescribeDBSnapshotAttributes

Errors returned by DescribeDBSnapshots

Errors returned by DescribeDBSubnetGroups

Errors returned by DescribeEngineDefaultClusterParameters

Errors returned by DescribeEngineDefaultParameters

Errors returned by DescribeEventCategories

Errors returned by DescribeEventSubscriptions

Errors returned by DescribeEvents

Errors returned by DescribeExportTasks

Errors returned by DescribeGlobalClusters

Errors returned by DescribeInstallationMedia

Errors returned by DescribeOptionGroupOptions

Errors returned by DescribeOptionGroups

Errors returned by DescribeOrderableDBInstanceOptions

Errors returned by DescribePendingMaintenanceActions

Errors returned by DescribeReservedDBInstances

Errors returned by DescribeReservedDBInstancesOfferings

Errors returned by DescribeSourceRegions

Errors returned by DescribeValidDBInstanceModifications

Errors returned by DownloadDBLogFilePortion

Errors returned by FailoverDBCluster

Errors returned by FailoverGlobalCluster

Errors returned by ImportInstallationMedia

Errors returned by ListTagsForResource

Errors returned by ModifyCertificates

Errors returned by ModifyCurrentDBClusterCapacity

Errors returned by ModifyDBClusterEndpoint

Errors returned by ModifyDBCluster

Errors returned by ModifyDBClusterParameterGroup

Errors returned by ModifyDBClusterSnapshotAttribute

Errors returned by ModifyDBInstance

Errors returned by ModifyDBParameterGroup

Errors returned by ModifyDBProxyEndpoint

Errors returned by ModifyDBProxy

Errors returned by ModifyDBProxyTargetGroup

Errors returned by ModifyDBSnapshotAttribute

Errors returned by ModifyDBSnapshot

Errors returned by ModifyDBSubnetGroup

Errors returned by ModifyEventSubscription

Errors returned by ModifyGlobalCluster

Errors returned by ModifyOptionGroup

Errors returned by PromoteReadReplicaDBCluster

Errors returned by PromoteReadReplica

Errors returned by PurchaseReservedDBInstancesOffering

Errors returned by RebootDBInstance

Errors returned by RegisterDBProxyTargets

Errors returned by RemoveFromGlobalCluster

Errors returned by RemoveRoleFromDBCluster

Errors returned by RemoveRoleFromDBInstance

Errors returned by RemoveSourceIdentifierFromSubscription

Errors returned by RemoveTagsFromResource

Errors returned by ResetDBClusterParameterGroup

Errors returned by ResetDBParameterGroup

Errors returned by RestoreDBClusterFromS3

Errors returned by RestoreDBClusterFromSnapshot

Errors returned by RestoreDBClusterToPointInTime

Errors returned by RestoreDBInstanceFromDBSnapshot

Errors returned by RestoreDBInstanceFromS3

Errors returned by RestoreDBInstanceToPointInTime

Errors returned by RevokeDBSecurityGroupIngress

Errors returned by StartActivityStream

Errors returned by StartDBCluster

Errors returned by StartDBInstanceAutomatedBackupsReplication

Errors returned by StartDBInstance

Errors returned by StartExportTask

Errors returned by StopActivityStream

Errors returned by StopDBCluster

Errors returned by StopDBInstanceAutomatedBackupsReplication

Errors returned by StopDBInstance

Traits

Trait representing the capabilities of the Amazon RDS API. Amazon RDS clients implement this trait.