AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccountQuota

Describes a quota for an AWS account, for example, the number of DB instances allowed.

Class AddRoleToDBClusterRequest

Container for the parameters to the AddRoleToDBCluster operation. Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

Class AddRoleToDBClusterResponse

This is the response object from the AddRoleToDBCluster operation.

Class AddSourceIdentifierToSubscriptionRequest

Container for the parameters to the AddSourceIdentifierToSubscription operation. Adds a source identifier to an existing RDS event notification subscription.

Class AddSourceIdentifierToSubscriptionResponse

This is the response object from the AddSourceIdentifierToSubscription operation.

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

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

Class AddTagsToResourceResponse

This is the response object from the AddTagsToResource operation.

Class ApplyPendingMaintenanceActionRequest

Container for the parameters to the ApplyPendingMaintenanceAction operation. Applies a pending maintenance action to a resource (for example, to a DB instance).

Class ApplyPendingMaintenanceActionResponse

This is the response object from the ApplyPendingMaintenanceAction operation.

Class AuthorizationAlreadyExistsException

RDS exception

Class AuthorizationNotFoundException

RDS exception

Class AuthorizationQuotaExceededException

RDS exception

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

You cannot authorize ingress from an EC2 security group in one AWS 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.

Class AuthorizeDBSecurityGroupIngressResponse

This is the response object from the AuthorizeDBSecurityGroupIngress operation.

Class AvailabilityZone

Contains Availability Zone information.

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

Class Certificate

A CA certificate for an AWS account.

Class CertificateNotFoundException

RDS exception

Class CharacterSet

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

Class CopyDBClusterParameterGroupRequest

Container for the parameters to the CopyDBClusterParameterGroup operation. Copies the specified DB cluster parameter group.

Class CopyDBClusterParameterGroupResponse

This is the response object from the CopyDBClusterParameterGroup operation.

Class CopyDBClusterSnapshotRequest

Container for the parameters to the CopyDBClusterSnapshot operation. Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot will be copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class CopyDBClusterSnapshotResponse

This is the response object from the CopyDBClusterSnapshot operation.

Class CopyDBParameterGroupRequest

Container for the parameters to the CopyDBParameterGroup operation. Copies the specified DB parameter group.

Class CopyDBParameterGroupResponse

This is the response object from the CopyDBParameterGroup operation.

Class CopyDBSnapshotRequest

Container for the parameters to the CopyDBSnapshot operation. Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

You cannot copy an encrypted, shared DB snapshot from one AWS Region to another.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

Class CopyDBSnapshotResponse

This is the response object from the CopyDBSnapshot operation.

Class CopyOptionGroupRequest

Container for the parameters to the CopyOptionGroup operation. Copies the specified option group.

Class CopyOptionGroupResponse

This is the response object from the CopyOptionGroup operation.

Class CreateDBClusterParameterGroupRequest

Container for the parameters to the CreateDBClusterParameterGroup operation. Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class CreateDBClusterParameterGroupResponse

This is the response object from the CreateDBClusterParameterGroup operation.

Class CreateDBClusterRequest

Container for the parameters to the CreateDBCluster operation. Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class CreateDBClusterResponse

This is the response object from the CreateDBCluster operation.

Class CreateDBClusterSnapshotRequest

Container for the parameters to the CreateDBClusterSnapshot operation. Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class CreateDBClusterSnapshotResponse

This is the response object from the CreateDBClusterSnapshot operation.

Class CreateDBInstanceReadReplicaRequest

Container for the parameters to the CreateDBInstanceReadReplica operation. Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL.

Amazon Aurora does not support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

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.

The source DB instance must have backup retention enabled.

For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.

Class CreateDBInstanceReadReplicaResponse

This is the response object from the CreateDBInstanceReadReplica operation.

Class CreateDBInstanceRequest

Container for the parameters to the CreateDBInstance operation. Creates a new DB instance.

Class CreateDBInstanceResponse

This is the response object from the CreateDBInstance operation.

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

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Class CreateDBParameterGroupResponse

This is the response object from the CreateDBParameterGroup operation.

Class CreateDBSecurityGroupRequest

Container for the parameters to the CreateDBSecurityGroup operation. Creates a new DB security group. DB security groups control access to a DB instance.

Class CreateDBSecurityGroupResponse

This is the response object from the CreateDBSecurityGroup operation.

Class CreateDBSnapshotRequest

Container for the parameters to the CreateDBSnapshot operation. Creates a DBSnapshot. The source DBInstance must be in "available" state.

Class CreateDBSnapshotResponse

This is the response object from the CreateDBSnapshot operation.

Class 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 AWS Region.

Class CreateDBSubnetGroupResponse

This is the response object from the CreateDBSubnetGroup operation.

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

Class CreateEventSubscriptionResponse

This is the response object from the CreateEventSubscription operation.

Class CreateOptionGroupRequest

Container for the parameters to the CreateOptionGroup operation. Creates a new option group. You can create up to 20 option groups.

Class CreateOptionGroupResponse

This is the response object from the CreateOptionGroup operation.

Class DBCluster

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

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

Class DBClusterAlreadyExistsException

RDS exception

Class DBClusterMember

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

Class DBClusterNotFoundException

RDS exception

Class DBClusterOptionGroupStatus

Contains status information for a DB cluster option group.

Class DBClusterParameterGroup

Contains the result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.

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

Class DBClusterParameterGroupNotFoundException

RDS exception

Class DBClusterQuotaExceededException

RDS exception

Class DBClusterRole

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

Class DBClusterRoleAlreadyExistsException

RDS exception

Class DBClusterRoleNotFoundException

RDS exception

Class DBClusterRoleQuotaExceededException

RDS exception

Class DBClusterSnapshot

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

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

Class DBClusterSnapshotAlreadyExistsException

RDS exception

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

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

Class DBClusterSnapshotNotFoundException

RDS exception

Class DBEngineVersion

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

Class DBInstance

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

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

Class DBInstanceAlreadyExistsException

RDS exception

Class DBInstanceNotFoundException

RDS exception

Class DBInstanceStatusInfo

Provides a list of status information for a DB instance.

Class DBLogFileNotFoundException

RDS exception

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

Class DBParameterGroupAlreadyExistsException

RDS exception

Class DBParameterGroupNotFoundException

RDS exception

Class DBParameterGroupQuotaExceededException

RDS exception

Class DBParameterGroupStatus

The status of the DB parameter group.

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

Class DBSecurityGroup

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

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

Class DBSecurityGroupAlreadyExistsException

RDS exception

Class DBSecurityGroupMembership

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

Class DBSecurityGroupNotFoundException

RDS exception

Class DBSecurityGroupNotSupportedException

RDS exception

Class DBSecurityGroupQuotaExceededException

RDS exception

Class DBSnapshot

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

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

Class DBSnapshotAlreadyExistsException

RDS exception

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

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

Class DBSnapshotNotFoundException

RDS exception

Class DBSubnetGroup

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

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

Class DBSubnetGroupAlreadyExistsException

RDS exception

Class DBSubnetGroupDoesNotCoverEnoughAZsException

RDS exception

Class DBSubnetGroupNotAllowedException

RDS exception

Class DBSubnetGroupNotFoundException

RDS exception

Class DBSubnetGroupQuotaExceededException

RDS exception

Class DBSubnetQuotaExceededException

RDS exception

Class DBUpgradeDependencyFailureException

RDS exception

Class DeleteDBClusterParameterGroupRequest

Container for the parameters to the DeleteDBClusterParameterGroup operation. Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DeleteDBClusterParameterGroupResponse

This is the response object from the DeleteDBClusterParameterGroup operation.

Class DeleteDBClusterRequest

Container for the parameters to the DeleteDBCluster operation. The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DeleteDBClusterResponse

This is the response object from the DeleteDBCluster operation.

Class DeleteDBClusterSnapshotRequest

Container for the parameters to the DeleteDBClusterSnapshot operation. Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DeleteDBClusterSnapshotResponse

This is the response object from the DeleteDBClusterSnapshot operation.

Class DeleteDBInstanceRequest

Container for the parameters to the DeleteDBInstance operation. The DeleteDBInstance action deletes a previously provisioned DB instance. 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 by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is 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.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if both of the following conditions are true:

  • The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

Class DeleteDBInstanceResponse

This is the response object from the DeleteDBInstance operation.

Class DeleteDBParameterGroupRequest

Container for the parameters to the DeleteDBParameterGroup operation. Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

Class DeleteDBParameterGroupResponse

This is the response object from the DeleteDBParameterGroup operation.

Class DeleteDBSecurityGroupRequest

Container for the parameters to the DeleteDBSecurityGroup operation. Deletes a DB security group.

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

Class DeleteDBSecurityGroupResponse

This is the response object from the DeleteDBSecurityGroup operation.

Class DeleteDBSnapshotRequest

Container for the parameters to the DeleteDBSnapshot operation. Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

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

Class DeleteDBSnapshotResponse

This is the response object from the DeleteDBSnapshot operation.

Class DeleteDBSubnetGroupRequest

Container for the parameters to the DeleteDBSubnetGroup operation. Deletes a DB subnet group.

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

Class DeleteDBSubnetGroupResponse

This is the response object from the DeleteDBSubnetGroup operation.

Class DeleteEventSubscriptionRequest

Container for the parameters to the DeleteEventSubscription operation. Deletes an RDS event notification subscription.

Class DeleteEventSubscriptionResponse

This is the response object from the DeleteEventSubscription operation.

Class DeleteOptionGroupRequest

Container for the parameters to the DeleteOptionGroup operation. Deletes an existing option group.

Class DeleteOptionGroupResponse

This is the response object from the DeleteOptionGroup operation.

Class DescribeAccountAttributesRequest

Container for the parameters to the DescribeAccountAttributes operation. Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

Class DescribeAccountAttributesResponse

Data returned by the DescribeAccountAttributes action.

Class DescribeCertificatesRequest

Container for the parameters to the DescribeCertificates operation. Lists the set of CA certificates provided by Amazon RDS for this AWS account.

Class DescribeCertificatesResponse

Data returned by the DescribeCertificates action.

Class DescribeDBClusterParameterGroupsRequest

Container for the parameters to the DescribeDBClusterParameterGroups operation. Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DescribeDBClusterParameterGroupsResponse

Class DescribeDBClusterParametersRequest

Container for the parameters to the DescribeDBClusterParameters operation. Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DescribeDBClusterParametersResponse

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

Class DescribeDBClusterSnapshotAttributesRequest

Container for the parameters to the DescribeDBClusterSnapshotAttributes operation. Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

Class DescribeDBClusterSnapshotAttributesResponse

This is the response object from the DescribeDBClusterSnapshotAttributes operation.

Class DescribeDBClusterSnapshotsRequest

Container for the parameters to the DescribeDBClusterSnapshots operation. Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DescribeDBClusterSnapshotsResponse

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

Class DescribeDBClustersRequest

Container for the parameters to the DescribeDBClusters operation. Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DescribeDBClustersResponse

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

Class DescribeDBEngineVersionsRequest

Container for the parameters to the DescribeDBEngineVersions operation. Returns a list of the available DB engines.

Class DescribeDBEngineVersionsResponse

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

Class DescribeDBInstancesRequest

Container for the parameters to the DescribeDBInstances operation. Returns information about provisioned RDS instances. This API supports pagination.

Class DescribeDBInstancesResponse

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

Class DescribeDBLogFilesDetails

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

Class DescribeDBLogFilesRequest

Container for the parameters to the DescribeDBLogFiles operation. Returns a list of DB log files for the DB instance.

Class DescribeDBLogFilesResponse

The response from a call to DescribeDBLogFiles.

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

Class DescribeDBParameterGroupsResponse

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

Class DescribeDBParametersRequest

Container for the parameters to the DescribeDBParameters operation. Returns the detailed parameter list for a particular DB parameter group.

Class DescribeDBParametersResponse

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

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

Class DescribeDBSecurityGroupsResponse

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

Class DescribeDBSnapshotAttributesRequest

Container for the parameters to the DescribeDBSnapshotAttributes operation. Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

Class DescribeDBSnapshotAttributesResponse

This is the response object from the DescribeDBSnapshotAttributes operation.

Class DescribeDBSnapshotsRequest

Container for the parameters to the DescribeDBSnapshots operation. Returns information about DB snapshots. This API action supports pagination.

Class DescribeDBSnapshotsResponse

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

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

Class DescribeDBSubnetGroupsResponse

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

Class DescribeEngineDefaultClusterParametersRequest

Container for the parameters to the DescribeEngineDefaultClusterParameters operation. Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class DescribeEngineDefaultClusterParametersResponse

This is the response object from the DescribeEngineDefaultClusterParameters operation.

Class DescribeEngineDefaultParametersRequest

Container for the parameters to the DescribeEngineDefaultParameters operation. Returns the default engine and system parameter information for the specified database engine.

Class DescribeEngineDefaultParametersResponse

This is the response object from the DescribeEngineDefaultParameters operation.

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

Class DescribeEventCategoriesResponse

Data returned from the DescribeEventCategories action.

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

Class DescribeEventsResponse

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

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

Class DescribeEventSubscriptionsResponse

Data returned by the DescribeEventSubscriptions action.

Class DescribeOptionGroupOptionsRequest

Container for the parameters to the DescribeOptionGroupOptions operation. Describes all available options.

Class DescribeOptionGroupOptionsResponse

Class DescribeOptionGroupsRequest

Container for the parameters to the DescribeOptionGroups operation. Describes the available option groups.

Class DescribeOptionGroupsResponse

List of option groups.

Class DescribeOrderableDBInstanceOptionsRequest

Container for the parameters to the DescribeOrderableDBInstanceOptions operation. Returns a list of orderable DB instance options for the specified engine.

Class DescribeOrderableDBInstanceOptionsResponse

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

Class DescribePendingMaintenanceActionsRequest

Container for the parameters to the DescribePendingMaintenanceActions operation. Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

Class DescribePendingMaintenanceActionsResponse

Data returned from the DescribePendingMaintenanceActions action.

Class DescribeReservedDBInstancesOfferingsRequest

Container for the parameters to the DescribeReservedDBInstancesOfferings operation. Lists available reserved DB instance offerings.

Class DescribeReservedDBInstancesOfferingsResponse

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

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

Class DescribeReservedDBInstancesResponse

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

Class DescribeSourceRegionsRequest

Container for the parameters to the DescribeSourceRegions operation. Returns a list of the source AWS regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

Class DescribeSourceRegionsResponse

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

Class DomainMembership

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

Class DomainNotFoundException

RDS exception

Class DownloadDBLogFilePortionRequest

Container for the parameters to the DownloadDBLogFilePortion operation. Downloads all or a portion of the specified log file, up to 1 MB in size.

Class DownloadDBLogFilePortionResponse

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

Class EC2SecurityGroup

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

Class Endpoint

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

Class EngineDefaults

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

Class Event

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

Class EventCategoriesMap

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

Class EventSubscription

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

Class EventSubscriptionQuotaExceededException

RDS exception

Class FailoverDBClusterRequest

Container for the parameters to the FailoverDBCluster operation. Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class FailoverDBClusterResponse

This is the response object from the FailoverDBCluster operation.

Class Filter

This type is not currently supported.

Class InstanceQuotaExceededException

RDS exception

Class InsufficientDBClusterCapacityException

RDS exception

Class InsufficientDBInstanceCapacityException

RDS exception

Class InsufficientStorageClusterCapacityException

RDS exception

Class InvalidDBClusterSnapshotStateException

RDS exception

Class InvalidDBClusterStateException

RDS exception

Class InvalidDBInstanceStateException

RDS exception

Class InvalidDBParameterGroupStateException

RDS exception

Class InvalidDBSecurityGroupStateException

RDS exception

Class InvalidDBSnapshotStateException

RDS exception

Class InvalidDBSubnetGroupException

RDS exception

Class InvalidDBSubnetGroupStateException

RDS exception

Class InvalidDBSubnetStateException

RDS exception

Class InvalidEventSubscriptionStateException

RDS exception

Class InvalidOptionGroupStateException

RDS exception

Class InvalidRestoreException

RDS exception

Class InvalidS3BucketException

RDS exception

Class InvalidSubnetException

RDS exception

Class InvalidVPCNetworkStateException

RDS exception

Class IPRange

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

Class KMSKeyNotAccessibleException

RDS exception

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

Class ListTagsForResourceResponse

Class ModifyDBClusterParameterGroupRequest

Container for the parameters to the ModifyDBClusterParameterGroup operation. Modifies the parameters of a DB cluster 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.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Class ModifyDBClusterParameterGroupResponse

Class ModifyDBClusterRequest

Container for the parameters to the ModifyDBCluster operation. Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class ModifyDBClusterResponse

This is the response object from the ModifyDBCluster operation.

Class ModifyDBClusterSnapshotAttributeRequest

Container for the parameters to the ModifyDBClusterSnapshotAttribute operation. Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

Class ModifyDBClusterSnapshotAttributeResponse

This is the response object from the ModifyDBClusterSnapshotAttribute operation.

Class ModifyDBInstanceRequest

Container for the parameters to the ModifyDBInstance operation. Modifies 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.

Class ModifyDBInstanceResponse

This is the response object from the ModifyDBInstance operation.

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

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Class ModifyDBParameterGroupResponse

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

Class ModifyDBSnapshotAttributeRequest

Container for the parameters to the ModifyDBSnapshotAttribute operation. Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.

Class ModifyDBSnapshotAttributeResponse

This is the response object from the ModifyDBSnapshotAttribute operation.

Class ModifyDBSnapshotRequest

Container for the parameters to the ModifyDBSnapshot operation. Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

Class ModifyDBSnapshotResponse

This is the response object from the ModifyDBSnapshot operation.

Class 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 AWS Region.

Class ModifyDBSubnetGroupResponse

This is the response object from the ModifyDBSubnetGroup operation.

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

Class ModifyEventSubscriptionResponse

This is the response object from the ModifyEventSubscription operation.

Class ModifyOptionGroupRequest

Container for the parameters to the ModifyOptionGroup operation. Modifies an existing option group.

Class ModifyOptionGroupResponse

This is the response object from the ModifyOptionGroup operation.

Class Option

Option details.

Class OptionConfiguration

A list of all available options

Class OptionGroup

Class OptionGroupAlreadyExistsException

RDS exception

Class OptionGroupMembership

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

Class OptionGroupNotFoundException

RDS exception

Class OptionGroupOption

Available option.

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

Class OptionGroupQuotaExceededException

RDS exception

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

Class OptionVersion

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

Class OrderableDBInstanceOption

Contains a list of available options for a DB instance

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

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

Class PendingMaintenanceAction

Provides information about a pending maintenance action for a resource.

Class PendingModifiedValues

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

Class PointInTimeRestoreNotEnabledException

RDS exception

Class PromoteReadReplicaDBClusterRequest

Container for the parameters to the PromoteReadReplicaDBCluster operation. Promotes a Read Replica DB cluster to a standalone DB cluster.

Class PromoteReadReplicaDBClusterResponse

This is the response object from the PromoteReadReplicaDBCluster operation.

Class PromoteReadReplicaRequest

Container for the parameters to the PromoteReadReplica operation. Promotes a Read Replica DB instance to a standalone DB instance.

We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

Class PromoteReadReplicaResponse

This is the response object from the PromoteReadReplica operation.

Class ProvisionedIopsNotAvailableInAZException

RDS exception

Class PurchaseReservedDBInstancesOfferingRequest

Container for the parameters to the PurchaseReservedDBInstancesOffering operation. Purchases a reserved DB instance offering.

Class PurchaseReservedDBInstancesOfferingResponse

This is the response object from the PurchaseReservedDBInstancesOffering operation.

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

Class RebootDBInstanceResponse

This is the response object from the RebootDBInstance operation.

Class RecurringCharge

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

Class RemoveRoleFromDBClusterRequest

Container for the parameters to the RemoveRoleFromDBCluster operation. Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

Class RemoveRoleFromDBClusterResponse

This is the response object from the RemoveRoleFromDBCluster operation.

Class RemoveSourceIdentifierFromSubscriptionRequest

Container for the parameters to the RemoveSourceIdentifierFromSubscription operation. Removes a source identifier from an existing RDS event notification subscription.

Class RemoveSourceIdentifierFromSubscriptionResponse

This is the response object from the RemoveSourceIdentifierFromSubscription operation.

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

Class RemoveTagsFromResourceResponse

This is the response object from the RemoveTagsFromResource operation.

Class ReservedDBInstance

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

Class ReservedDBInstanceAlreadyExistsException

RDS exception

Class ReservedDBInstanceNotFoundException

RDS exception

Class ReservedDBInstanceQuotaExceededException

RDS exception

Class ReservedDBInstancesOffering

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

Class ReservedDBInstancesOfferingNotFoundException

RDS exception

Class ResetDBClusterParameterGroupRequest

Container for the parameters to the ResetDBClusterParameterGroup operation. Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName 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. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class ResetDBClusterParameterGroupResponse

Class 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, provide 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.

Class ResetDBParameterGroupResponse

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

Class ResourceNotFoundException

RDS exception

Class ResourcePendingMaintenanceActions

Describes the pending maintenance actions for a resource.

Class RestoreDBClusterFromS3Request

Container for the parameters to the RestoreDBClusterFromS3 operation. Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket.

Class RestoreDBClusterFromS3Response

This is the response object from the RestoreDBClusterFromS3 operation.

Class RestoreDBClusterFromSnapshotRequest

Container for the parameters to the RestoreDBClusterFromSnapshot operation. Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class RestoreDBClusterFromSnapshotResponse

This is the response object from the RestoreDBClusterFromSnapshot operation.

Class RestoreDBClusterToPointInTimeRequest

Container for the parameters to the RestoreDBClusterToPointInTime operation. Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Class RestoreDBClusterToPointInTimeResponse

This is the response object from the RestoreDBClusterToPointInTime operation.

Class 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 most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Class RestoreDBInstanceFromDBSnapshotResponse

This is the response object from the RestoreDBInstanceFromDBSnapshot operation.

Class RestoreDBInstanceToPointInTimeRequest

Container for the parameters to the RestoreDBInstanceToPointInTime operation. Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

Class RestoreDBInstanceToPointInTimeResponse

This is the response object from the RestoreDBInstanceToPointInTime operation.

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

Class RevokeDBSecurityGroupIngressResponse

This is the response object from the RevokeDBSecurityGroupIngress operation.

Class SharedSnapshotQuotaExceededException

RDS exception

Class SnapshotQuotaExceededException

RDS exception

Class SNSInvalidTopicException

RDS exception

Class SNSNoAuthorizationException

RDS exception

Class SNSTopicArnNotFoundException

RDS exception

Class SourceNotFoundException

RDS exception

Class SourceRegion

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

Class StartDBInstanceRequest

Container for the parameters to the StartDBInstance operation. Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.

Class StartDBInstanceResponse

This is the response object from the StartDBInstance operation.

Class StopDBInstanceRequest

Container for the parameters to the StopDBInstance operation. Stops a DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.

Class StopDBInstanceResponse

This is the response object from the StopDBInstance operation.

Class StorageQuotaExceededException

RDS exception

Class StorageTypeNotSupportedException

RDS exception

Class Subnet

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

Class SubnetAlreadyInUseException

RDS exception

Class SubscriptionAlreadyExistException

RDS exception

Class SubscriptionCategoryNotFoundException

RDS exception

Class SubscriptionNotFoundException

RDS exception

Class Tag

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

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

Class UpgradeTarget

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

Class VpcSecurityGroupMembership

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