AWS SDK for .NET Documentation
Amazon.RDS.Model Namespace
AmazonAmazon.RDS.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.RDS.Model
Types
All TypesClasses
IconTypeDescription
AddSourceIdentifierToSubscriptionRequest
Container for the parameters to the AddSourceIdentifierToSubscription operation.

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


AddSourceIdentifierToSubscriptionResponse
Returns information about the AddSourceIdentifierToSubscription response and response metadata.

AddSourceIdentifierToSubscriptionResult
The results from the AddSourceIdentifierToSubscription action.

AddTagsToResourceRequest
Container for the parameters to the AddTagsToResource operation.

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 Condition statement in IAM policy for Amazon RDS.

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


AddTagsToResourceResponse
Returns information about the AddTagsToResource response metadata. The AddTagsToResource operation has a void result type.

AuthorizationAlreadyExistsException
AmazonRDS exception

AuthorizationNotFoundException
AmazonRDS exception

AuthorizationQuotaExceededException
AmazonRDS exception

AuthorizeDBSecurityGroupIngressRequest
Container for the parameters to the AuthorizeDBSecurityGroupIngress operation.

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

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

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


AuthorizeDBSecurityGroupIngressResponse
Returns information about the AuthorizeDBSecurityGroupIngress response and response metadata.

AuthorizeDBSecurityGroupIngressResult
The results from the AuthorizeDBSecurityGroupIngress action.

AvailabilityZone

Contains Availability Zone information.

This data type is used as an element in the following data type:

  • OrderableDBInstanceOption


CharacterSet

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


CopyDBSnapshotRequest
Container for the parameters to the CopyDBSnapshot operation.

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


CopyDBSnapshotResponse
Returns information about the CopyDBSnapshot response and response metadata.

CopyDBSnapshotResult
The results from the CopyDBSnapshot action.

CreateDBInstanceReadReplicaRequest
Container for the parameters to the CreateDBInstanceReadReplica operation.

Creates a DB instance that acts as a read replica of a source DB instance.

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

IMPORTANT: The source DB instance must have backup retention enabled.


CreateDBInstanceReadReplicaResponse
Returns information about the CreateDBInstanceReadReplica response and response metadata.

CreateDBInstanceReadReplicaResult
The results from the CreateDBInstanceReadReplica action.

CreateDBInstanceRequest
Container for the parameters to the CreateDBInstance operation.

Creates a new DB instance.


CreateDBInstanceResponse
Returns information about the CreateDBInstance response and response metadata.

CreateDBInstanceResult
The results from the CreateDBInstance action.

CreateDBParameterGroupRequest
Container for the parameters to the CreateDBParameterGroup operation.

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 for the new DB parameter group and associated settings to take effect.


CreateDBParameterGroupResponse
Returns information about the CreateDBParameterGroup response and response metadata.

CreateDBParameterGroupResult
The results from the CreateDBParameterGroup action.

CreateDBSecurityGroupRequest
Container for the parameters to the CreateDBSecurityGroup operation.

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


CreateDBSecurityGroupResponse
Returns information about the CreateDBSecurityGroup response and response metadata.

CreateDBSecurityGroupResult
The results from the CreateDBSecurityGroup action.

CreateDBSnapshotRequest
Container for the parameters to the CreateDBSnapshot operation.

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


CreateDBSnapshotResponse
Returns information about the CreateDBSnapshot response and response metadata.

CreateDBSnapshotResult
The results from the CreateDBSnapshot action.

CreateDBSubnetGroupRequest
Container for the parameters to the CreateDBSubnetGroup operation.

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


CreateDBSubnetGroupResponse
Returns information about the CreateDBSubnetGroup response and response metadata.

CreateDBSubnetGroupResult
The results from the CreateDBSubnetGroup action.

CreateEventSubscriptionRequest
Container for the parameters to the CreateEventSubscription operation.

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

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

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


CreateEventSubscriptionResponse
Returns information about the CreateEventSubscription response and response metadata.

CreateEventSubscriptionResult
The results from the CreateEventSubscription action.

CreateOptionGroupRequest
Container for the parameters to the CreateOptionGroup operation.

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


CreateOptionGroupResponse
Returns information about the CreateOptionGroup response and response metadata.

CreateOptionGroupResult
The results from the CreateOptionGroup action.

DBEngineVersion

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


DBInstance

Contains the result of a successful invocation of the following actions:

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance

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


DBInstanceAlreadyExistsException
AmazonRDS exception

DBInstanceNotFoundException
AmazonRDS exception

DBInstanceStatusInfo

Provides a list of status information for a DB instance.


DBParameterGroup

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

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.


DBParameterGroupAlreadyExistsException
AmazonRDS exception

DBParameterGroupNotFoundException
AmazonRDS exception

DBParameterGroupQuotaExceededException
AmazonRDS exception

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

DBSecurityGroup

Contains the result of a successful invocation of the following actions:

  • DescribeDBSecurityGroups
  • AuthorizeDBSecurityGroupIngress
  • CreateDBSecurityGroup
  • RevokeDBSecurityGroupIngress

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


DBSecurityGroupAlreadyExistsException
AmazonRDS exception

DBSecurityGroupMembership

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

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime

DBSecurityGroupNotFoundException
AmazonRDS exception

DBSecurityGroupNotSupportedException
AmazonRDS exception

DBSecurityGroupQuotaExceededException
AmazonRDS exception

DBSnapshot

Contains the result of a successful invocation of the following actions:

  • CreateDBSnapshot
  • DeleteDBSnapshot

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


DBSnapshotAlreadyExistsException
AmazonRDS exception

DBSnapshotNotFoundException
AmazonRDS exception

DBSubnetGroup

Contains the result of a successful invocation of the following actions:

  • CreateDBSubnetGroup
  • ModifyDBSubnetGroup
  • DescribeDBSubnetGroups
  • DeleteDBSubnetGroup

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


DBSubnetGroupAlreadyExistsException
AmazonRDS exception

DBSubnetGroupDoesNotCoverEnoughAZsException
AmazonRDS exception

DBSubnetGroupNotAllowedException
AmazonRDS exception

DBSubnetGroupNotFoundException
AmazonRDS exception

DBSubnetGroupQuotaExceededException
AmazonRDS exception

DBSubnetQuotaExceededException
AmazonRDS exception

DBUpgradeDependencyFailureException
AmazonRDS exception

DeleteDBInstanceRequest
Container for the parameters to the DeleteDBInstance operation.

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.


DeleteDBInstanceResponse
Returns information about the DeleteDBInstance response and response metadata.

DeleteDBInstanceResult
The results from the DeleteDBInstance action.

DeleteDBParameterGroupRequest
Container for the parameters to the DeleteDBParameterGroup operation.

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

NOTE: The specified DB parameter group cannot be associated with any DB instances.


DeleteDBParameterGroupResponse
Returns information about the DeleteDBParameterGroup response metadata. The DeleteDBParameterGroup operation has a void result type.

DeleteDBSecurityGroupRequest
Container for the parameters to the DeleteDBSecurityGroup operation.

Deletes a DB security group.

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


DeleteDBSecurityGroupResponse
Returns information about the DeleteDBSecurityGroup response metadata. The DeleteDBSecurityGroup operation has a void result type.

DeleteDBSnapshotRequest
Container for the parameters to the DeleteDBSnapshot operation.

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

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


DeleteDBSnapshotResponse
Returns information about the DeleteDBSnapshot response and response metadata.

DeleteDBSnapshotResult
The results from the DeleteDBSnapshot action.

DeleteDBSubnetGroupRequest
Container for the parameters to the DeleteDBSubnetGroup operation.

Deletes a DB subnet group.

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


DeleteDBSubnetGroupResponse
Returns information about the DeleteDBSubnetGroup response metadata. The DeleteDBSubnetGroup operation has a void result type.

DeleteEventSubscriptionRequest
Container for the parameters to the DeleteEventSubscription operation.

Deletes an RDS event notification subscription.


DeleteEventSubscriptionResponse
Returns information about the DeleteEventSubscription response and response metadata.

DeleteEventSubscriptionResult
The results from the DeleteEventSubscription action.

DeleteOptionGroupRequest
Container for the parameters to the DeleteOptionGroup operation.

Deletes an existing option group.


DeleteOptionGroupResponse
Returns information about the DeleteOptionGroup response metadata. The DeleteOptionGroup operation has a void result type.

DescribeDBEngineVersionsRequest
Container for the parameters to the DescribeDBEngineVersions operation.

Returns a list of the available DB engines.


DescribeDBEngineVersionsResponse
Returns information about the DescribeDBEngineVersionsResult response and response metadata.

DescribeDBEngineVersionsResult

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


DescribeDBInstancesRequest
Container for the parameters to the DescribeDBInstances operation.

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


DescribeDBInstancesResponse
Returns information about the DescribeDBInstancesResult response and response metadata.

DescribeDBInstancesResult

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


DescribeDBLogFilesDetails

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


DescribeDBLogFilesRequest
Container for the parameters to the DescribeDBLogFiles operation.

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


DescribeDBLogFilesResponse
Returns information about the DescribeDBLogFilesResult response and response metadata.

DescribeDBLogFilesResult

The response from a call to DescribeDBLogFiles.


DescribeDBParameterGroupsRequest
Container for the parameters to the DescribeDBParameterGroups operation.

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


DescribeDBParameterGroupsResponse
Returns information about the DescribeDBParameterGroupsResult response and response metadata.

DescribeDBParameterGroupsResult

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


DescribeDBParametersRequest
Container for the parameters to the DescribeDBParameters operation.

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


DescribeDBParametersResponse
Returns information about the DescribeDBParametersResult response and response metadata.

DescribeDBParametersResult

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


DescribeDBSecurityGroupsRequest
Container for the parameters to the DescribeDBSecurityGroups operation.

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


DescribeDBSecurityGroupsResponse
Returns information about the DescribeDBSecurityGroupsResult response and response metadata.

DescribeDBSecurityGroupsResult

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


DescribeDBSnapshotsRequest
Container for the parameters to the DescribeDBSnapshots operation.

Returns information about DB snapshots. This API supports pagination.


DescribeDBSnapshotsResponse
Returns information about the DescribeDBSnapshotsResult response and response metadata.

DescribeDBSnapshotsResult

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


DescribeDBSubnetGroupsRequest
Container for the parameters to the DescribeDBSubnetGroups operation.

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 .


DescribeDBSubnetGroupsResponse
Returns information about the DescribeDBSubnetGroupsResult response and response metadata.

DescribeDBSubnetGroupsResult

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


DescribeEngineDefaultParametersRequest
Container for the parameters to the DescribeEngineDefaultParameters operation.

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


DescribeEngineDefaultParametersResponse
Returns information about the DescribeEngineDefaultParameters response and response metadata.

DescribeEngineDefaultParametersResult
The results from the DescribeEngineDefaultParameters action.

DescribeEventCategoriesRequest
Container for the parameters to the DescribeEventCategories operation.

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.


DescribeEventCategoriesResponse
Returns information about the DescribeEventCategoriesResult response and response metadata.

DescribeEventCategoriesResult

Data returned from the DescribeEventCategories action.


DescribeEventsRequest
Container for the parameters to the DescribeEvents operation.

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.


DescribeEventsResponse
Returns information about the DescribeEventsResult response and response metadata.

DescribeEventsResult

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


DescribeEventSubscriptionsRequest
Container for the parameters to the DescribeEventSubscriptions operation.

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.


DescribeEventSubscriptionsResponse
Returns information about the DescribeEventSubscriptionsResult response and response metadata.

DescribeEventSubscriptionsResult

Data returned by the DescribeEventSubscriptions action.


DescribeOptionGroupOptionsRequest
Container for the parameters to the DescribeOptionGroupOptions operation.

Describes all available options.


DescribeOptionGroupOptionsResponse
Returns information about the DescribeOptionGroupOptionsResult response and response metadata.

DescribeOptionGroupOptionsResult


DescribeOptionGroupsRequest
Container for the parameters to the DescribeOptionGroups operation.

Describes the available option groups.


DescribeOptionGroupsResponse
Returns information about the DescribeOptionGroupsResult response and response metadata.

DescribeOptionGroupsResult

List of option groups.


DescribeOrderableDBInstanceOptionsRequest
Container for the parameters to the DescribeOrderableDBInstanceOptions operation.

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


DescribeOrderableDBInstanceOptionsResponse
Returns information about the DescribeOrderableDBInstanceOptionsResult response and response metadata.

DescribeOrderableDBInstanceOptionsResult

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


DescribeReservedDBInstancesOfferingsRequest
Container for the parameters to the DescribeReservedDBInstancesOfferings operation.

Lists available reserved DB instance offerings.


DescribeReservedDBInstancesOfferingsResponse
Returns information about the DescribeReservedDBInstancesOfferingsResult response and response metadata.

DescribeReservedDBInstancesOfferingsResult

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


DescribeReservedDBInstancesRequest
Container for the parameters to the DescribeReservedDBInstances operation.

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


DescribeReservedDBInstancesResponse
Returns information about the DescribeReservedDBInstancesResult response and response metadata.

DescribeReservedDBInstancesResult

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


DownloadDBLogFilePortionRequest
Container for the parameters to the DownloadDBLogFilePortion operation.

Downloads the last line of the specified log file.


DownloadDBLogFilePortionResponse
Returns information about the DownloadDBLogFilePortionResult response and response metadata.

DownloadDBLogFilePortionResult

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


EC2SecurityGroup

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

  • AuthorizeDBSecurityGroupIngress
  • DescribeDBSecurityGroups
  • RevokeDBSecurityGroupIngress

Endpoint

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

  • CreateDBInstance
  • DescribeDBInstances
  • DeleteDBInstance

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.


EventSubscription

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


EventSubscriptionQuotaExceededException
AmazonRDS exception

Filter

InstanceQuotaExceededException
AmazonRDS exception

InsufficientDBInstanceCapacityException
AmazonRDS exception

InvalidDBInstanceStateException
AmazonRDS exception

InvalidDBParameterGroupStateException
AmazonRDS exception

InvalidDBSecurityGroupStateException
AmazonRDS exception

InvalidDBSnapshotStateException
AmazonRDS exception

InvalidDBSubnetGroupException
AmazonRDS exception

InvalidDBSubnetGroupStateException
AmazonRDS exception

InvalidDBSubnetStateException
AmazonRDS exception

InvalidEventSubscriptionStateException
AmazonRDS exception

InvalidOptionGroupStateException
AmazonRDS exception

InvalidRestoreException
AmazonRDS exception

InvalidSubnetException
AmazonRDS exception

InvalidVPCNetworkStateException
AmazonRDS exception

IPRange

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


ListTagsForResourceRequest
Container for the parameters to the ListTagsForResource operation.

Lists all tags on an Amazon RDS resource.

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


ListTagsForResourceResponse
Returns information about the ListTagsForResourceResult response and response metadata.

ListTagsForResourceResult

ModifyDBInstanceRequest
Container for the parameters to the ModifyDBInstance operation.

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


ModifyDBInstanceResponse
Returns information about the ModifyDBInstance response and response metadata.

ModifyDBInstanceResult
The results from the ModifyDBInstance action.

ModifyDBParameterGroupRequest
Container for the parameters to the ModifyDBParameterGroup operation.

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.

NOTE: The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB instances for either dynamic or static parameters. For Microsoft SQL Server DB instances, the pending-reboot method can be used only for static parameters.


ModifyDBParameterGroupResponse
Returns information about the ModifyDBParameterGroupResult response and response metadata.

ModifyDBParameterGroupResult

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


ModifyDBSubnetGroupRequest
Container for the parameters to the ModifyDBSubnetGroup operation.

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


ModifyDBSubnetGroupResponse
Returns information about the ModifyDBSubnetGroup response and response metadata.

ModifyDBSubnetGroupResult
The results from the ModifyDBSubnetGroup action.

ModifyEventSubscriptionRequest
Container for the parameters to the ModifyEventSubscription operation.

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.


ModifyEventSubscriptionResponse
Returns information about the ModifyEventSubscription response and response metadata.

ModifyEventSubscriptionResult
The results from the ModifyEventSubscription action.

ModifyOptionGroupRequest
Container for the parameters to the ModifyOptionGroup operation.

Modifies an existing option group.


ModifyOptionGroupResponse
Returns information about the ModifyOptionGroup response and response metadata.

ModifyOptionGroupResult
The results from the ModifyOptionGroup action.

Option

Option details.


OptionConfiguration

A list of all available options


OptionGroup


OptionGroupAlreadyExistsException
AmazonRDS exception

OptionGroupMembership

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


OptionGroupNotFoundException
AmazonRDS exception

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.


OptionGroupQuotaExceededException
AmazonRDS exception

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.


OrderableDBInstanceOption

Contains a list of available options for a DB instance

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


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.


PendingModifiedValues

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


PointInTimeRestoreNotEnabledException
AmazonRDS exception

PromoteReadReplicaRequest
Container for the parameters to the PromoteReadReplica operation.

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


PromoteReadReplicaResponse
Returns information about the PromoteReadReplica response and response metadata.

PromoteReadReplicaResult
The results from the PromoteReadReplica action.

ProvisionedIopsNotAvailableInAZException
AmazonRDS exception

PurchaseReservedDBInstancesOfferingRequest
Container for the parameters to the PurchaseReservedDBInstancesOffering operation.

Purchases a reserved DB instance offering.


PurchaseReservedDBInstancesOfferingResponse
Returns information about the PurchaseReservedDBInstancesOffering response and response metadata.

PurchaseReservedDBInstancesOfferingResult
The results from the PurchaseReservedDBInstancesOffering action.

RebootDBInstanceRequest
Container for the parameters to the RebootDBInstance operation.

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.


RebootDBInstanceResponse
Returns information about the RebootDBInstance response and response metadata.

RebootDBInstanceResult
The results from the RebootDBInstance action.

RecurringCharge

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


RemoveSourceIdentifierFromSubscriptionRequest
Container for the parameters to the RemoveSourceIdentifierFromSubscription operation.

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


RemoveSourceIdentifierFromSubscriptionResponse
Returns information about the RemoveSourceIdentifierFromSubscription response and response metadata.

RemoveSourceIdentifierFromSubscriptionResult
The results from the RemoveSourceIdentifierFromSubscription action.

RemoveTagsFromResourceRequest
Container for the parameters to the RemoveTagsFromResource operation.

Removes metadata tags from an Amazon RDS resource.

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


RemoveTagsFromResourceResponse
Returns information about the RemoveTagsFromResource response metadata. The RemoveTagsFromResource operation has a void result type.

ReservedDBInstance

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


ReservedDBInstanceAlreadyExistsException
AmazonRDS exception

ReservedDBInstanceNotFoundException
AmazonRDS exception

ReservedDBInstanceQuotaExceededException
AmazonRDS exception

ReservedDBInstancesOffering

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


ReservedDBInstancesOfferingNotFoundException
AmazonRDS exception

ResetDBParameterGroupRequest
Container for the parameters to the ResetDBParameterGroup operation.

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit 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.


ResetDBParameterGroupResponse
Returns information about the ResetDBParameterGroupResult response and response metadata.

ResetDBParameterGroupResult

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


RestoreDBInstanceFromDBSnapshotRequest
Container for the parameters to the RestoreDBInstanceFromDBSnapshot operation.

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.


RestoreDBInstanceFromDBSnapshotResponse
Returns information about the RestoreDBInstanceFromDBSnapshot response and response metadata.

RestoreDBInstanceFromDBSnapshotResult
The results from the RestoreDBInstanceFromDBSnapshot action.

RestoreDBInstanceToPointInTimeRequest
Container for the parameters to the RestoreDBInstanceToPointInTime operation.

Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.


RestoreDBInstanceToPointInTimeResponse
Returns information about the RestoreDBInstanceToPointInTime response and response metadata.

RestoreDBInstanceToPointInTimeResult
The results from the RestoreDBInstanceToPointInTime action.

RevokeDBSecurityGroupIngressRequest
Container for the parameters to the RevokeDBSecurityGroupIngress operation.

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


RevokeDBSecurityGroupIngressResponse
Returns information about the RevokeDBSecurityGroupIngress response and response metadata.

RevokeDBSecurityGroupIngressResult
The results from the RevokeDBSecurityGroupIngress action.

SnapshotQuotaExceededException
AmazonRDS exception

SNSInvalidTopicException
AmazonRDS exception

SNSNoAuthorizationException
AmazonRDS exception

SNSTopicArnNotFoundException
AmazonRDS exception

SourceNotFoundException
AmazonRDS exception

StorageQuotaExceededException
AmazonRDS exception

Subnet

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


SubnetAlreadyInUseException
AmazonRDS exception

SubscriptionAlreadyExistException
AmazonRDS exception

SubscriptionCategoryNotFoundException
AmazonRDS exception

SubscriptionNotFoundException
AmazonRDS exception

Tag

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


VpcSecurityGroupMembership

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