rds-2014-10-31
library
Classes
AccountAttributesMessage
Data returned by the DescribeAccountAttributes action.
AccountQuota
Describes a quota for an AWS account.
AddSourceIdentifierToSubscriptionResult
ApplyPendingMaintenanceActionResult
AuthorizeDBSecurityGroupIngressResult
AvailabilityZone
Contains Availability Zone information.
AvailableProcessorFeature
Contains the available processor feature information for the DB instance
class of a DB instance.
AwsClientCredentials
AWS credentials.
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.
ClusterPendingModifiedValues
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.
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
.
CopyDBClusterParameterGroupResult
CopyDBClusterSnapshotResult
CopyDBParameterGroupResult
CopyDBSnapshotResult
CopyOptionGroupResult
CreateCustomAvailabilityZoneResult
CreateDBClusterParameterGroupResult
CreateDBClusterResult
CreateDBClusterSnapshotResult
CreateDBInstanceReadReplicaResult
CreateDBInstanceResult
CreateDBParameterGroupResult
CreateDBProxyResponse
CreateDBSecurityGroupResult
CreateDBSnapshotResult
CreateDBSubnetGroupResult
CreateEventSubscriptionResult
CreateGlobalClusterResult
CreateOptionGroupResult
CustomAvailabilityZone
A custom Availability Zone (AZ) is an on-premises AZ that is integrated with
a VMware vSphere cluster.
CustomAvailabilityZoneMessage
DBCluster
Contains the details of an Amazon Aurora DB cluster.
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:
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.
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
DBClusterSnapshotAttribute
Contains the name and values of a manual DB cluster snapshot attribute.
DBClusterSnapshotAttributesResult
Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
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.
DBInstanceAutomatedBackup
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.
DBInstanceAutomatedBackupMessage
Contains the result of a successful invocation of the
DescribeDBInstanceAutomatedBackups
action.
DBInstanceAutomatedBackupsReplication
Automated backups of a DB instance replicated to another AWS Region. They
consist of system backups, transaction logs, and database instance
properties.
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.
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.
DBParameterGroupsMessage
Contains the result of a successful invocation of the
DescribeDBParameterGroups
action.
DBParameterGroupStatus
The status of the DB parameter group.
DBProxy
The data structure representing a proxy managed by the RDS Proxy.
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.
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.
DBSecurityGroup
Contains the details for an Amazon RDS DB security group.
DBSecurityGroupMembership
This data type is used as a response element in the following actions:
DBSecurityGroupMessage
Contains the result of a successful invocation of the
DescribeDBSecurityGroups
action.
DBSnapshot
Contains the details of an Amazon RDS DB snapshot.
DBSnapshotAttribute
Contains the name and values of a manual DB snapshot attribute
DBSnapshotAttributesResult
Contains the results of a successful call to the
DescribeDBSnapshotAttributes
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.
DBSubnetGroupMessage
Contains the result of a successful invocation of the
DescribeDBSubnetGroups
action.
DeleteCustomAvailabilityZoneResult
DeleteDBClusterResult
DeleteDBClusterSnapshotResult
DeleteDBInstanceAutomatedBackupResult
DeleteDBInstanceResult
DeleteDBProxyResponse
DeleteDBSnapshotResult
DeleteEventSubscriptionResult
DeleteGlobalClusterResult
DeregisterDBProxyTargetsResponse
DescribeDBClusterSnapshotAttributesResult
DescribeDBLogFilesDetails
This data type is used as a response element to
DescribeDBLogFiles
.
DescribeDBLogFilesResponse
The response from a call to DescribeDBLogFiles
.
DescribeDBProxiesResponse
DescribeDBProxyTargetGroupsResponse
DescribeDBProxyTargetsResponse
DescribeDBSnapshotAttributesResult
DescribeEngineDefaultClusterParametersResult
DescribeEngineDefaultParametersResult
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
.
EC2SecurityGroup
This data type is used as a response element in the following actions:
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:
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
operation.
EventCategoriesMessage
Data returned from the DescribeEventCategories
operation.
EventsMessage
Contains the result of a successful invocation of the
DescribeEvents
action.
EventSubscription
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.
EventSubscriptionsMessage
Data returned by the DescribeEventSubscriptions action.
ExportTask
Contains the details of a snapshot export to Amazon S3.
ExportTasksMessage
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.
The following actions can be filtered:
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
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
IPRange
This data type is used as a response element in the
DescribeDBSecurityGroups
action.
MinimumEngineVersionPerAllowedValue
The minimum DB engine version required for each corresponding allowed value
for an option setting.
ModifyCertificatesResult
ModifyDBClusterResult
ModifyDBClusterSnapshotAttributeResult
ModifyDBInstanceResult
ModifyDBProxyResponse
ModifyDBProxyTargetGroupResponse
ModifyDBSnapshotAttributeResult
ModifyDBSnapshotResult
ModifyDBSubnetGroupResult
ModifyEventSubscriptionResult
ModifyGlobalClusterResult
ModifyOptionGroupResult
Option
Option details.
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.
OrderableDBInstanceOptionsMessage
Contains the result of a successful invocation of the
DescribeOrderableDBInstanceOptions
action.
Outpost
A data type that represents an Outpost.
Parameter
This data type is used as a request parameter in the
ModifyDBParameterGroup
and ResetDBParameterGroup
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 and contains changes that will be
applied during the next maintenance window.
ProcessorFeature
Contains the processor features of a DB instance class.
PromoteReadReplicaDBClusterResult
PromoteReadReplicaResult
PurchaseReservedDBInstancesOfferingResult
Range
A range of integer values.
RDS
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.
RebootDBInstanceResult
RecurringCharge
This data type is used as a response element in the
DescribeReservedDBInstances
and
DescribeReservedDBInstancesOfferings
actions.
RegisterDBProxyTargetsResponse
RemoveFromGlobalClusterResult
RemoveSourceIdentifierFromSubscriptionResult
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.
ResourcePendingMaintenanceActions
Describes the pending maintenance actions for a resource.
RestoreDBClusterFromS3Result
RestoreDBClusterFromSnapshotResult
RestoreDBClusterToPointInTimeResult
RestoreDBInstanceFromDBSnapshotResult
RestoreDBInstanceFromS3Result
RestoreDBInstanceToPointInTimeResult
RestoreWindow
Earliest and latest time an instance can be restored to:
RevokeDBSecurityGroupIngressResult
ScalingConfiguration
Contains the scaling configuration of an Aurora Serverless DB cluster.
ScalingConfigurationInfo
Shows the scaling configuration for an Aurora DB cluster in
serverless
DB engine mode.
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.
StartActivityStreamResponse
StartDBClusterResult
StartDBInstanceAutomatedBackupsReplicationResult
StartDBInstanceResult
StopActivityStreamResponse
StopDBClusterResult
StopDBInstanceAutomatedBackupsReplicationResult
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.