Crate rusoto_rds

Source
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§

AccountAttributesMessage

Data returned by the DescribeAccountAttributes action.

AccountQuota

Describes a quota for an AWS 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 AWS 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.

  • ManualSnapshots - The number of manual DB snapshots per account. The used value is the count of the manual DB 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.

AddRoleToDBClusterMessage
AddRoleToDBInstanceMessage
AddSourceIdentifierToSubscriptionMessage

AddSourceIdentifierToSubscriptionResult
AddTagsToResourceMessage

ApplyPendingMaintenanceActionMessage

ApplyPendingMaintenanceActionResult
AuthorizeDBSecurityGroupIngressMessage

AuthorizeDBSecurityGroupIngressResult
AvailabilityZone

Contains Availability Zone information.

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

AvailableProcessorFeature

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.

BacktrackDBClusterMessage

CancelExportTaskMessage
Certificate

A CA certificate for an AWS account.

CertificateMessage

Data returned by the DescribeCertificates action.

CharacterSet

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

CloudwatchLogsExportConfiguration

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, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

ConnectionPoolConfiguration

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

ConnectionPoolConfigurationInfo

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

CopyDBClusterParameterGroupMessage
CopyDBClusterParameterGroupResult
CopyDBClusterSnapshotMessage

CopyDBClusterSnapshotResult
CopyDBParameterGroupMessage

CopyDBParameterGroupResult
CopyDBSnapshotMessage

CopyDBSnapshotResult
CopyOptionGroupMessage

CopyOptionGroupResult
CreateCustomAvailabilityZoneMessage

CreateCustomAvailabilityZoneResult
CreateDBClusterEndpointMessage
CreateDBClusterMessage

CreateDBClusterParameterGroupMessage

CreateDBClusterParameterGroupResult
CreateDBClusterResult
CreateDBClusterSnapshotMessage

CreateDBClusterSnapshotResult
CreateDBInstanceMessage

CreateDBInstanceReadReplicaMessage
CreateDBInstanceReadReplicaResult
CreateDBInstanceResult
CreateDBParameterGroupMessage

CreateDBParameterGroupResult
CreateDBProxyRequest
CreateDBProxyResponse
CreateDBSecurityGroupMessage

CreateDBSecurityGroupResult
CreateDBSnapshotMessage

CreateDBSnapshotResult
CreateDBSubnetGroupMessage

CreateDBSubnetGroupResult
CreateEventSubscriptionMessage

CreateEventSubscriptionResult
CreateGlobalClusterMessage
CreateGlobalClusterResult
CreateOptionGroupMessage

CreateOptionGroupResult
CustomAvailabilityZone

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.

CustomAvailabilityZoneMessage
DBCluster

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.

DBClusterBacktrack

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

DBClusterBacktrackMessage

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

DBClusterCapacityInfo
DBClusterEndpoint

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.

DBClusterEndpointMessage
DBClusterMember

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

DBClusterMessage

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

DBClusterOptionGroupStatus

Contains status information for a DB cluster option group.

DBClusterParameterGroup

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

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

DBClusterParameterGroupDetails

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

DBClusterParameterGroupNameMessage

DBClusterParameterGroupsMessage

DBClusterRole

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

DBClusterSnapshot

Contains the details for an Amazon RDS DB cluster snapshot

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

DBClusterSnapshotAttribute

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

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

DBClusterSnapshotAttributesResult

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

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

DBClusterSnapshotMessage

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

DBEngineVersion

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

DBEngineVersionMessage

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

DBInstance

Contains the details of an Amazon RDS DB instance.

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

DBInstanceAutomatedBackup

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

DBInstanceAutomatedBackupMessage

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

DBInstanceMessage

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

DBInstanceRole

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

DBInstanceStatusInfo

Provides a list of status information for a DB instance.

DBParameterGroup

Contains the details of an Amazon RDS DB parameter group.

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

DBParameterGroupDetails

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

DBParameterGroupNameMessage

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

DBParameterGroupStatus

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

DBParameterGroupsMessage

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

DBProxy

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

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

DBProxyTarget

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.

DBProxyTargetGroup

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.

DBSecurityGroup

Contains the details for an Amazon RDS DB security group.

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

DBSecurityGroupMembership

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

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceToPointInTime

DBSecurityGroupMessage

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

DBSnapshot

Contains the details of an Amazon RDS DB snapshot.

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

DBSnapshotAttribute

Contains the name and values of a manual DB snapshot attribute

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

DBSnapshotAttributesResult

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

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

DBSnapshotMessage

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

DBSubnetGroup

Contains the details of an Amazon RDS DB subnet group.

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

DBSubnetGroupMessage

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

DeleteCustomAvailabilityZoneMessage
DeleteCustomAvailabilityZoneResult
DeleteDBClusterEndpointMessage
DeleteDBClusterMessage

DeleteDBClusterParameterGroupMessage

DeleteDBClusterResult
DeleteDBClusterSnapshotMessage

DeleteDBClusterSnapshotResult
DeleteDBInstanceAutomatedBackupMessage

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

DeleteDBInstanceAutomatedBackupResult
DeleteDBInstanceMessage

DeleteDBInstanceResult
DeleteDBParameterGroupMessage

DeleteDBProxyRequest
DeleteDBProxyResponse
DeleteDBSecurityGroupMessage

DeleteDBSnapshotMessage

DeleteDBSnapshotResult
DeleteDBSubnetGroupMessage

DeleteEventSubscriptionMessage

DeleteEventSubscriptionResult
DeleteGlobalClusterMessage
DeleteGlobalClusterResult
DeleteInstallationMediaMessage
DeleteOptionGroupMessage

DeregisterDBProxyTargetsRequest
DeregisterDBProxyTargetsResponse
DescribeAccountAttributesMessage

DescribeCertificatesMessage

DescribeCustomAvailabilityZonesMessage
DescribeDBClusterBacktracksMessage

DescribeDBClusterEndpointsMessage
DescribeDBClusterParameterGroupsMessage

DescribeDBClusterParametersMessage

DescribeDBClusterSnapshotAttributesMessage

DescribeDBClusterSnapshotAttributesResult
DescribeDBClusterSnapshotsMessage

DescribeDBClustersMessage

DescribeDBEngineVersionsMessage
DescribeDBInstanceAutomatedBackupsMessage

Parameter input for DescribeDBInstanceAutomatedBackups.

DescribeDBInstancesMessage

DescribeDBLogFilesDetails

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

DescribeDBLogFilesMessage

DescribeDBLogFilesResponse

The response from a call to DescribeDBLogFiles.

DescribeDBParameterGroupsMessage

DescribeDBParametersMessage
DescribeDBProxiesRequest
DescribeDBProxiesResponse
DescribeDBProxyTargetGroupsRequest
DescribeDBProxyTargetGroupsResponse
DescribeDBProxyTargetsRequest
DescribeDBProxyTargetsResponse
DescribeDBSecurityGroupsMessage

DescribeDBSnapshotAttributesMessage

DescribeDBSnapshotAttributesResult
DescribeDBSnapshotsMessage

DescribeDBSubnetGroupsMessage

DescribeEngineDefaultClusterParametersMessage

DescribeEngineDefaultClusterParametersResult
DescribeEngineDefaultParametersMessage

DescribeEngineDefaultParametersResult
DescribeEventCategoriesMessage

DescribeEventSubscriptionsMessage

DescribeEventsMessage

DescribeExportTasksMessage
DescribeGlobalClustersMessage
DescribeInstallationMediaMessage
DescribeOptionGroupOptionsMessage

DescribeOptionGroupsMessage

DescribeOrderableDBInstanceOptionsMessage

DescribePendingMaintenanceActionsMessage

DescribeReservedDBInstancesMessage

DescribeReservedDBInstancesOfferingsMessage

DescribeSourceRegionsMessage

DescribeValidDBInstanceModificationsMessage

DescribeValidDBInstanceModificationsResult
DomainMembership

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

DoubleRange

A range of double values.

DownloadDBLogFilePortionDetails

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

DownloadDBLogFilePortionMessage

EC2SecurityGroup

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

  • AuthorizeDBSecurityGroupIngress

  • DescribeDBSecurityGroups

  • RevokeDBSecurityGroupIngress

Endpoint

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.

EngineDefaults

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

Event

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

EventCategoriesMap

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

EventCategoriesMessage

Data returned from the DescribeEventCategories action.

EventSubscription

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

EventSubscriptionsMessage

Data returned by the DescribeEventSubscriptions action.

EventsMessage

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

ExportTask

Contains the details of a snapshot export to Amazon S3.

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

ExportTasksMessage
FailoverDBClusterMessage

FailoverDBClusterResult
Filter

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

GlobalCluster

A data type representing an Aurora global database.

GlobalClusterMember

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

GlobalClustersMessage
IPRange

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

ImportInstallationMediaMessage
InstallationMedia

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

InstallationMediaFailureCause

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.

InstallationMediaMessage
ListTagsForResourceMessage

MinimumEngineVersionPerAllowedValue

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

ModifyCertificatesMessage
ModifyCertificatesResult
ModifyCurrentDBClusterCapacityMessage
ModifyDBClusterEndpointMessage
ModifyDBClusterMessage

ModifyDBClusterParameterGroupMessage

ModifyDBClusterResult
ModifyDBClusterSnapshotAttributeMessage

ModifyDBClusterSnapshotAttributeResult
ModifyDBInstanceMessage

ModifyDBInstanceResult
ModifyDBParameterGroupMessage

ModifyDBProxyRequest
ModifyDBProxyResponse
ModifyDBProxyTargetGroupRequest
ModifyDBProxyTargetGroupResponse
ModifyDBSnapshotAttributeMessage

ModifyDBSnapshotAttributeResult
ModifyDBSnapshotMessage
ModifyDBSnapshotResult
ModifyDBSubnetGroupMessage

ModifyDBSubnetGroupResult
ModifyEventSubscriptionMessage

ModifyEventSubscriptionResult
ModifyGlobalClusterMessage
ModifyGlobalClusterResult
ModifyOptionGroupMessage

ModifyOptionGroupResult
OptionConfiguration

A list of all available options

OptionGroup

OptionGroupMembership

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

OptionGroupOption

Available option.

OptionGroupOptionSetting

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.

OptionGroupOptionsMessage

OptionGroups

List of option groups.

OptionSetting

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.

OptionVersion

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

OrderableDBInstanceOption

Contains a list of available options for a DB instance.

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

OrderableDBInstanceOptionsMessage

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

Outpost

A data type that represents an Outpost.

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

Parameter

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.

PendingCloudwatchLogsExports

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.

PendingMaintenanceAction

Provides information about a pending maintenance action for a resource.

PendingMaintenanceActionsMessage

Data returned from the DescribePendingMaintenanceActions action.

PendingModifiedValues

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

ProcessorFeature

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

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

PromoteReadReplicaDBClusterMessage

PromoteReadReplicaDBClusterResult
PromoteReadReplicaMessage

PromoteReadReplicaResult
PurchaseReservedDBInstancesOfferingMessage

PurchaseReservedDBInstancesOfferingResult
RDSOption

Option details.

Range

A range of integer values.

RdsClient
A client for the Amazon RDS API.
RebootDBInstanceMessage

RebootDBInstanceResult
RecurringCharge

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

RegisterDBProxyTargetsRequest
RegisterDBProxyTargetsResponse
RemoveFromGlobalClusterMessage
RemoveFromGlobalClusterResult
RemoveRoleFromDBClusterMessage
RemoveRoleFromDBInstanceMessage
RemoveSourceIdentifierFromSubscriptionMessage

RemoveSourceIdentifierFromSubscriptionResult
RemoveTagsFromResourceMessage

ReservedDBInstance

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

ReservedDBInstanceMessage

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

ReservedDBInstancesOffering

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

ReservedDBInstancesOfferingMessage

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

ResetDBClusterParameterGroupMessage

ResetDBParameterGroupMessage

ResourcePendingMaintenanceActions

Describes the pending maintenance actions for a resource.

RestoreDBClusterFromS3Message
RestoreDBClusterFromS3Result
RestoreDBClusterFromSnapshotMessage

RestoreDBClusterFromSnapshotResult
RestoreDBClusterToPointInTimeMessage

RestoreDBClusterToPointInTimeResult
RestoreDBInstanceFromDBSnapshotMessage

RestoreDBInstanceFromDBSnapshotResult
RestoreDBInstanceFromS3Message
RestoreDBInstanceFromS3Result
RestoreDBInstanceToPointInTimeMessage

RestoreDBInstanceToPointInTimeResult
RestoreWindow

Earliest and latest time an instance can be restored to:

RevokeDBSecurityGroupIngressMessage

RevokeDBSecurityGroupIngressResult
ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless DB cluster.

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

ScalingConfigurationInfo

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.

SourceRegion

Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

SourceRegionMessage

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

StartActivityStreamRequest
StartActivityStreamResponse
StartDBClusterMessage
StartDBClusterResult
StartDBInstanceMessage
StartDBInstanceResult
StartExportTaskMessage
StopActivityStreamRequest
StopActivityStreamResponse
StopDBClusterMessage
StopDBClusterResult
StopDBInstanceMessage
StopDBInstanceResult
Subnet

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

Tag

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

TagListMessage

TargetHealth

Information about the connection health of an RDS Proxy target.

Timezone

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.

UpgradeTarget

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

UserAuthConfig

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

UserAuthConfigInfo

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

ValidDBInstanceModificationsMessage

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.

ValidStorageOptions

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

VpcSecurityGroupMembership

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

VpnDetails

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

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

Enums§

AddRoleToDBClusterError
Errors returned by AddRoleToDBCluster
AddRoleToDBInstanceError
Errors returned by AddRoleToDBInstance
AddSourceIdentifierToSubscriptionError
Errors returned by AddSourceIdentifierToSubscription
AddTagsToResourceError
Errors returned by AddTagsToResource
ApplyPendingMaintenanceActionError
Errors returned by ApplyPendingMaintenanceAction
AuthorizeDBSecurityGroupIngressError
Errors returned by AuthorizeDBSecurityGroupIngress
BacktrackDBClusterError
Errors returned by BacktrackDBCluster
CancelExportTaskError
Errors returned by CancelExportTask
CopyDBClusterParameterGroupError
Errors returned by CopyDBClusterParameterGroup
CopyDBClusterSnapshotError
Errors returned by CopyDBClusterSnapshot
CopyDBParameterGroupError
Errors returned by CopyDBParameterGroup
CopyDBSnapshotError
Errors returned by CopyDBSnapshot
CopyOptionGroupError
Errors returned by CopyOptionGroup
CreateCustomAvailabilityZoneError
Errors returned by CreateCustomAvailabilityZone
CreateDBClusterEndpointError
Errors returned by CreateDBClusterEndpoint
CreateDBClusterError
Errors returned by CreateDBCluster
CreateDBClusterParameterGroupError
Errors returned by CreateDBClusterParameterGroup
CreateDBClusterSnapshotError
Errors returned by CreateDBClusterSnapshot
CreateDBInstanceError
Errors returned by CreateDBInstance
CreateDBInstanceReadReplicaError
Errors returned by CreateDBInstanceReadReplica
CreateDBParameterGroupError
Errors returned by CreateDBParameterGroup
CreateDBProxyError
Errors returned by CreateDBProxy
CreateDBSecurityGroupError
Errors returned by CreateDBSecurityGroup
CreateDBSnapshotError
Errors returned by CreateDBSnapshot
CreateDBSubnetGroupError
Errors returned by CreateDBSubnetGroup
CreateEventSubscriptionError
Errors returned by CreateEventSubscription
CreateGlobalClusterError
Errors returned by CreateGlobalCluster
CreateOptionGroupError
Errors returned by CreateOptionGroup
DeleteCustomAvailabilityZoneError
Errors returned by DeleteCustomAvailabilityZone
DeleteDBClusterEndpointError
Errors returned by DeleteDBClusterEndpoint
DeleteDBClusterError
Errors returned by DeleteDBCluster
DeleteDBClusterParameterGroupError
Errors returned by DeleteDBClusterParameterGroup
DeleteDBClusterSnapshotError
Errors returned by DeleteDBClusterSnapshot
DeleteDBInstanceAutomatedBackupError
Errors returned by DeleteDBInstanceAutomatedBackup
DeleteDBInstanceError
Errors returned by DeleteDBInstance
DeleteDBParameterGroupError
Errors returned by DeleteDBParameterGroup
DeleteDBProxyError
Errors returned by DeleteDBProxy
DeleteDBSecurityGroupError
Errors returned by DeleteDBSecurityGroup
DeleteDBSnapshotError
Errors returned by DeleteDBSnapshot
DeleteDBSubnetGroupError
Errors returned by DeleteDBSubnetGroup
DeleteEventSubscriptionError
Errors returned by DeleteEventSubscription
DeleteGlobalClusterError
Errors returned by DeleteGlobalCluster
DeleteInstallationMediaError
Errors returned by DeleteInstallationMedia
DeleteOptionGroupError
Errors returned by DeleteOptionGroup
DeregisterDBProxyTargetsError
Errors returned by DeregisterDBProxyTargets
DescribeAccountAttributesError
Errors returned by DescribeAccountAttributes
DescribeCertificatesError
Errors returned by DescribeCertificates
DescribeCustomAvailabilityZonesError
Errors returned by DescribeCustomAvailabilityZones
DescribeDBClusterBacktracksError
Errors returned by DescribeDBClusterBacktracks
DescribeDBClusterEndpointsError
Errors returned by DescribeDBClusterEndpoints
DescribeDBClusterParameterGroupsError
Errors returned by DescribeDBClusterParameterGroups
DescribeDBClusterParametersError
Errors returned by DescribeDBClusterParameters
DescribeDBClusterSnapshotAttributesError
Errors returned by DescribeDBClusterSnapshotAttributes
DescribeDBClusterSnapshotsError
Errors returned by DescribeDBClusterSnapshots
DescribeDBClustersError
Errors returned by DescribeDBClusters
DescribeDBEngineVersionsError
Errors returned by DescribeDBEngineVersions
DescribeDBInstanceAutomatedBackupsError
Errors returned by DescribeDBInstanceAutomatedBackups
DescribeDBInstancesError
Errors returned by DescribeDBInstances
DescribeDBLogFilesError
Errors returned by DescribeDBLogFiles
DescribeDBParameterGroupsError
Errors returned by DescribeDBParameterGroups
DescribeDBParametersError
Errors returned by DescribeDBParameters
DescribeDBProxiesError
Errors returned by DescribeDBProxies
DescribeDBProxyTargetGroupsError
Errors returned by DescribeDBProxyTargetGroups
DescribeDBProxyTargetsError
Errors returned by DescribeDBProxyTargets
DescribeDBSecurityGroupsError
Errors returned by DescribeDBSecurityGroups
DescribeDBSnapshotAttributesError
Errors returned by DescribeDBSnapshotAttributes
DescribeDBSnapshotsError
Errors returned by DescribeDBSnapshots
DescribeDBSubnetGroupsError
Errors returned by DescribeDBSubnetGroups
DescribeEngineDefaultClusterParametersError
Errors returned by DescribeEngineDefaultClusterParameters
DescribeEngineDefaultParametersError
Errors returned by DescribeEngineDefaultParameters
DescribeEventCategoriesError
Errors returned by DescribeEventCategories
DescribeEventSubscriptionsError
Errors returned by DescribeEventSubscriptions
DescribeEventsError
Errors returned by DescribeEvents
DescribeExportTasksError
Errors returned by DescribeExportTasks
DescribeGlobalClustersError
Errors returned by DescribeGlobalClusters
DescribeInstallationMediaError
Errors returned by DescribeInstallationMedia
DescribeOptionGroupOptionsError
Errors returned by DescribeOptionGroupOptions
DescribeOptionGroupsError
Errors returned by DescribeOptionGroups
DescribeOrderableDBInstanceOptionsError
Errors returned by DescribeOrderableDBInstanceOptions
DescribePendingMaintenanceActionsError
Errors returned by DescribePendingMaintenanceActions
DescribeReservedDBInstancesError
Errors returned by DescribeReservedDBInstances
DescribeReservedDBInstancesOfferingsError
Errors returned by DescribeReservedDBInstancesOfferings
DescribeSourceRegionsError
Errors returned by DescribeSourceRegions
DescribeValidDBInstanceModificationsError
Errors returned by DescribeValidDBInstanceModifications
DownloadDBLogFilePortionError
Errors returned by DownloadDBLogFilePortion
FailoverDBClusterError
Errors returned by FailoverDBCluster
ImportInstallationMediaError
Errors returned by ImportInstallationMedia
ListTagsForResourceError
Errors returned by ListTagsForResource
ModifyCertificatesError
Errors returned by ModifyCertificates
ModifyCurrentDBClusterCapacityError
Errors returned by ModifyCurrentDBClusterCapacity
ModifyDBClusterEndpointError
Errors returned by ModifyDBClusterEndpoint
ModifyDBClusterError
Errors returned by ModifyDBCluster
ModifyDBClusterParameterGroupError
Errors returned by ModifyDBClusterParameterGroup
ModifyDBClusterSnapshotAttributeError
Errors returned by ModifyDBClusterSnapshotAttribute
ModifyDBInstanceError
Errors returned by ModifyDBInstance
ModifyDBParameterGroupError
Errors returned by ModifyDBParameterGroup
ModifyDBProxyError
Errors returned by ModifyDBProxy
ModifyDBProxyTargetGroupError
Errors returned by ModifyDBProxyTargetGroup
ModifyDBSnapshotAttributeError
Errors returned by ModifyDBSnapshotAttribute
ModifyDBSnapshotError
Errors returned by ModifyDBSnapshot
ModifyDBSubnetGroupError
Errors returned by ModifyDBSubnetGroup
ModifyEventSubscriptionError
Errors returned by ModifyEventSubscription
ModifyGlobalClusterError
Errors returned by ModifyGlobalCluster
ModifyOptionGroupError
Errors returned by ModifyOptionGroup
PromoteReadReplicaDBClusterError
Errors returned by PromoteReadReplicaDBCluster
PromoteReadReplicaError
Errors returned by PromoteReadReplica
PurchaseReservedDBInstancesOfferingError
Errors returned by PurchaseReservedDBInstancesOffering
RebootDBInstanceError
Errors returned by RebootDBInstance
RegisterDBProxyTargetsError
Errors returned by RegisterDBProxyTargets
RemoveFromGlobalClusterError
Errors returned by RemoveFromGlobalCluster
RemoveRoleFromDBClusterError
Errors returned by RemoveRoleFromDBCluster
RemoveRoleFromDBInstanceError
Errors returned by RemoveRoleFromDBInstance
RemoveSourceIdentifierFromSubscriptionError
Errors returned by RemoveSourceIdentifierFromSubscription
RemoveTagsFromResourceError
Errors returned by RemoveTagsFromResource
ResetDBClusterParameterGroupError
Errors returned by ResetDBClusterParameterGroup
ResetDBParameterGroupError
Errors returned by ResetDBParameterGroup
RestoreDBClusterFromS3Error
Errors returned by RestoreDBClusterFromS3
RestoreDBClusterFromSnapshotError
Errors returned by RestoreDBClusterFromSnapshot
RestoreDBClusterToPointInTimeError
Errors returned by RestoreDBClusterToPointInTime
RestoreDBInstanceFromDBSnapshotError
Errors returned by RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3Error
Errors returned by RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTimeError
Errors returned by RestoreDBInstanceToPointInTime
RevokeDBSecurityGroupIngressError
Errors returned by RevokeDBSecurityGroupIngress
StartActivityStreamError
Errors returned by StartActivityStream
StartDBClusterError
Errors returned by StartDBCluster
StartDBInstanceError
Errors returned by StartDBInstance
StartExportTaskError
Errors returned by StartExportTask
StopActivityStreamError
Errors returned by StopActivityStream
StopDBClusterError
Errors returned by StopDBCluster
StopDBInstanceError
Errors returned by StopDBInstance

Traits§

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