Package-level declarations

Types

Link copied to clipboard

Represents the input to AddSourceIdentifierToSubscription.

Link copied to clipboard

Represents the input to AddTagsToResource.

Link copied to clipboard
Link copied to clipboard
sealed class ApplyMethod
Link copied to clipboard

Represents the input to ApplyPendingMaintenanceAction.

Link copied to clipboard

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Link copied to clipboard

Information about an Availability Zone.

Link copied to clipboard

A certificate authority (CA) certificate for an Amazon Web Services account.

Link copied to clipboard

Returns the details of the DB instance’s server certificate.

Link copied to clipboard

CertificateIdentifier doesn't refer to an existing certificate.

Link copied to clipboard

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

Link copied to clipboard

Represents the input to CopyDBClusterParameterGroup.

Link copied to clipboard

Represents the input to CopyDBClusterSnapshot.

Link copied to clipboard

Represents the input of CreateDBClusterParameterGroup.

Link copied to clipboard

Represents the input to CreateDBCluster.

Link copied to clipboard
Link copied to clipboard

Represents the input of CreateDBClusterSnapshot.

Link copied to clipboard

Represents the input to CreateDBInstance.

Link copied to clipboard
Link copied to clipboard

Represents the input to CreateDBSubnetGroup.

Link copied to clipboard

Represents the input to CreateEventSubscription.

Link copied to clipboard

Represents the input to CreateGlobalCluster.

Link copied to clipboard
class DbCluster

Detailed information about a cluster.

Link copied to clipboard

You already have a cluster with the given identifier.

Link copied to clipboard

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

Link copied to clipboard

DBClusterIdentifier doesn't refer to an existing cluster.

Link copied to clipboard

Detailed information about a cluster parameter group.

Link copied to clipboard

DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

Link copied to clipboard

The cluster can't be created because you have reached the maximum allowed quota of clusters.

Link copied to clipboard

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

Link copied to clipboard

Detailed information about a cluster snapshot.

Link copied to clipboard

You already have a cluster snapshot with the given identifier.

Link copied to clipboard

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

Link copied to clipboard

Detailed information about the attributes that are associated with a cluster snapshot.

Link copied to clipboard

DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

Link copied to clipboard

Detailed information about an engine version.

Link copied to clipboard

Detailed information about an instance.

Link copied to clipboard

You already have a instance with the given identifier.

Link copied to clipboard

DBInstanceIdentifier doesn't refer to an existing instance.

Link copied to clipboard

Provides a list of status information for an instance.

Link copied to clipboard

A parameter group with the same name already exists.

Link copied to clipboard

DBParameterGroupName doesn't refer to an existing parameter group.

Link copied to clipboard

This request would cause you to exceed the allowed number of parameter groups.

Link copied to clipboard

DBSecurityGroupName doesn't refer to an existing security group.

Link copied to clipboard

DBSnapshotIdentifier is already being used by an existing snapshot.

Link copied to clipboard

DBSnapshotIdentifier doesn't refer to an existing snapshot.

Link copied to clipboard

Detailed information about a subnet group.

Link copied to clipboard

DBSubnetGroupName is already being used by an existing subnet group.

Link copied to clipboard

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

Link copied to clipboard

DBSubnetGroupName doesn't refer to an existing subnet group.

Link copied to clipboard

The request would cause you to exceed the allowed number of subnet groups.

Link copied to clipboard

The request would cause you to exceed the allowed number of subnets in a subnet group.

Link copied to clipboard

The upgrade failed because a resource that the depends on can't be modified.

Link copied to clipboard

Represents the input to DeleteDBClusterParameterGroup.

Link copied to clipboard

Represents the input to DeleteDBCluster.

Link copied to clipboard
Link copied to clipboard

Represents the input to DeleteDBClusterSnapshot.

Link copied to clipboard

Represents the input to DeleteDBInstance.

Link copied to clipboard
Link copied to clipboard

Represents the input to DeleteDBSubnetGroup.

Link copied to clipboard

Represents the input to DeleteEventSubscription.

Link copied to clipboard

Represents the input to DeleteGlobalCluster.

Link copied to clipboard

Represents the input to DescribeDBClusterParameterGroups.

Link copied to clipboard

Represents the output of DBClusterParameterGroups.

Link copied to clipboard

Represents the input to DescribeDBClusterParameters.

Link copied to clipboard

Represents the output of DBClusterParameterGroup.

Represents the input to DescribeDBClusterSnapshotAttributes.

Link copied to clipboard

Represents the input to DescribeDBClusterSnapshots.

Link copied to clipboard

Represents the output of DescribeDBClusterSnapshots.

Link copied to clipboard

Represents the input to DescribeDBClusters.

Link copied to clipboard

Represents the output of DescribeDBClusters.

Link copied to clipboard

Represents the input to DescribeDBEngineVersions.

Link copied to clipboard

Represents the output of DescribeDBEngineVersions.

Link copied to clipboard

Represents the input to DescribeDBInstances.

Link copied to clipboard

Represents the output of DescribeDBInstances.

Link copied to clipboard

Represents the input to DescribeDBSubnetGroups.

Link copied to clipboard

Represents the output of DescribeDBSubnetGroups.

Represents the input to DescribeEngineDefaultClusterParameters.

Link copied to clipboard

Represents the input to DescribeEventCategories.

Link copied to clipboard

Represents the output of DescribeEventCategories.

Link copied to clipboard

Represents the input to DescribeEvents.

Link copied to clipboard

Represents the output of DescribeEvents.

Link copied to clipboard

Represents the input to DescribeEventSubscriptions.

Link copied to clipboard

Represents the output of DescribeEventSubscriptions.

Represents the input to DescribeOrderableDBInstanceOptions.

Represents the output of DescribeOrderableDBInstanceOptions.

Link copied to clipboard

Represents the input to DescribePendingMaintenanceActions.

Represents the output of DescribePendingMaintenanceActions.

Link copied to clipboard

Base class for all service related exceptions thrown by the DocDb client

Link copied to clipboard
class Endpoint

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

Link copied to clipboard

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

Link copied to clipboard
class Event

Detailed information about an event.

Link copied to clipboard

An event source type, accompanied by one or more event category names.

Link copied to clipboard

Detailed information about an event to which you have subscribed.

Link copied to clipboard

You have reached the maximum number of event subscriptions.

Link copied to clipboard

Represents the input to FailoverDBCluster.

Link copied to clipboard
Link copied to clipboard
class Filter

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Link copied to clipboard

A data type representing an Amazon DocumentDB global cluster.

Link copied to clipboard

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

Link copied to clipboard

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

Link copied to clipboard

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

Link copied to clipboard

The number of global clusters for this account is already at the maximum allowed.

Link copied to clipboard

The request would cause you to exceed the allowed number of instances.

Link copied to clipboard

The cluster doesn't have enough capacity for the current operation.

Link copied to clipboard

The specified instance class isn't available in the specified Availability Zone.

Link copied to clipboard

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

Link copied to clipboard

The provided value isn't a valid cluster snapshot state.

Link copied to clipboard

The cluster isn't in a valid state.

Link copied to clipboard

The specified instance isn't in the available state.

Link copied to clipboard

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

Link copied to clipboard

The state of the security group doesn't allow deletion.

Link copied to clipboard

The state of the snapshot doesn't allow deletion.

Link copied to clipboard

The subnet group can't be deleted because it's in use.

Link copied to clipboard

The subnet isn't in the available state.

Link copied to clipboard

Someone else might be modifying a subscription. Wait a few seconds, and try again.

Link copied to clipboard

The requested operation can't be performed while the cluster is in this state.

Link copied to clipboard

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

Link copied to clipboard

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

Link copied to clipboard

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

Link copied to clipboard

An error occurred when accessing an KMS key.

Link copied to clipboard

Represents the input to ListTagsForResource.

Link copied to clipboard

Represents the output of ListTagsForResource.

Link copied to clipboard

Represents the input to ModifyDBClusterParameterGroup.

Link copied to clipboard

Contains the name of a cluster parameter group.

Link copied to clipboard

Represents the input to ModifyDBCluster.

Link copied to clipboard
Link copied to clipboard

Represents the input to ModifyDBClusterSnapshotAttribute.

Link copied to clipboard

Represents the input to ModifyDBInstance.

Link copied to clipboard
Link copied to clipboard

Represents the input to ModifyDBSubnetGroup.

Link copied to clipboard

Represents the input to ModifyEventSubscription.

Link copied to clipboard

Represents the input to ModifyGlobalCluster.

Link copied to clipboard

The options that are available for an instance.

Link copied to clipboard
class Parameter

Detailed information about an individual parameter.

Link copied to clipboard

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

Link copied to clipboard

Provides information about a pending maintenance action for a resource.

Link copied to clipboard

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

Link copied to clipboard

Represents the input to RebootDBInstance.

Link copied to clipboard
Link copied to clipboard

Represents the input to RemoveFromGlobalCluster.

Represents the input to RemoveSourceIdentifierFromSubscription.

Link copied to clipboard

Represents the input to RemoveTagsFromResource.

Link copied to clipboard

Represents the input to ResetDBClusterParameterGroup.

Link copied to clipboard

Contains the name of a cluster parameter group.

Link copied to clipboard

The specified resource ID was not found.

Link copied to clipboard

Represents the output of ApplyPendingMaintenanceAction.

Link copied to clipboard

Represents the input to RestoreDBClusterFromSnapshot.

Link copied to clipboard

Represents the input to RestoreDBClusterToPointInTime.

Link copied to clipboard

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

Link copied to clipboard

The request would cause you to exceed the allowed number of snapshots.

Link copied to clipboard

Amazon SNS has responded that there is a problem with the specified topic.

Link copied to clipboard

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

Link copied to clipboard

The SNS topic Amazon Resource Name (ARN) does not exist.

Link copied to clipboard

The requested source could not be found.

Link copied to clipboard
sealed class SourceType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request would cause you to exceed the allowed amount of storage available across all instances.

Link copied to clipboard

Storage of the specified StorageType can't be associated with the DB instance.

Link copied to clipboard
class Subnet

Detailed information about a subnet.

Link copied to clipboard

The subnet is already in use in the Availability Zone.

Link copied to clipboard

The provided subscription name already exists.

Link copied to clipboard

The provided category does not exist.

Link copied to clipboard

The subscription name does not exist.

Link copied to clipboard
class Tag

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

Link copied to clipboard

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

Link copied to clipboard

Used as a response element for queries on virtual private cloud (VPC) security group membership.