View Source AWS.DocDB (aws-elixir v1.0.4)
Amazon DocumentDB is a fast, reliable, and fully managed database service.
Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.
Link to this section Summary
Functions
Adds a source identifier to an existing event notification subscription.
Adds metadata tags to an Amazon DocumentDB resource.
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
Copies the specified cluster parameter group.
Copies a snapshot of a cluster.
Creates a new Amazon DocumentDB cluster.
Creates a new cluster parameter group.
Creates a snapshot of a cluster.
Creates a new instance.
Creates a new subnet group.
Creates an Amazon DocumentDB event notification subscription.
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.
Deletes a previously provisioned cluster.
Deletes a specified cluster parameter group.
Deletes a cluster snapshot.
Deletes a previously provisioned instance.
Deletes a subnet group.
Deletes an Amazon DocumentDB event notification subscription.
Deletes a global cluster.
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
Returns a list of DBClusterParameterGroup descriptions.
Returns the detailed parameter list for a particular cluster parameter group.
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
Returns information about cluster snapshots.
Returns information about provisioned Amazon DocumentDB clusters.
Returns a list of the available engines.
Returns information about provisioned Amazon DocumentDB instances.
Returns a list of DBSubnetGroup descriptions.
Returns the default engine and system parameter information for the cluster database engine.
Displays a list of categories for all event source types, or, if specified, for a specified source type.
Lists all the subscription descriptions for a customer account.
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
Returns information about Amazon DocumentDB global clusters.
Returns a list of orderable instance options for the specified engine.
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
Forces a failover for a cluster.
Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.
Lists all tags on an Amazon DocumentDB resource.
Modifies a setting for an Amazon DocumentDB cluster.
Modifies the parameters of a cluster parameter group.
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
Modifies settings for an instance.
Modifies an existing subnet group.
Modifies an existing Amazon DocumentDB event notification subscription.
Modify a setting for an Amazon DocumentDB global cluster.
You might need to reboot your instance, usually for maintenance reasons.
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
Removes metadata tags from an Amazon DocumentDB resource.
Modifies the parameters of a cluster parameter group to the default value.
Creates a new cluster from a snapshot or cluster snapshot.
Restores a cluster to an arbitrary point in time.
Restarts the stopped cluster that is specified by DBClusterIdentifier.
Stops the running cluster that is specified by DBClusterIdentifier.
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
Link to this section Functions
add_source_identifier_to_subscription(client, input, options \\ [])
View SourceAdds a source identifier to an existing event notification subscription.
Adds metadata tags to an Amazon DocumentDB resource.
You can use these tags
with cost allocation reporting to track costs that are associated
with Amazon DocumentDB resources or in a Condition statement in
an Identity and Access Management (IAM) policy for Amazon DocumentDB.
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
Copies the specified cluster parameter group.
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot,
SourceDBClusterSnapshotIdentifier must be the Amazon
Resource Name (ARN) of the shared cluster snapshot. You can only
copy a shared DB cluster snapshot, whether encrypted or not, in the
same Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the
target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster
snapshot is in the copying status.
Creates a new Amazon DocumentDB cluster.
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default
parameters for the database engine used by instances in the cluster.
In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6 cluster parameter group. If your
Amazon DocumentDB cluster is using the default cluster parameter group and you
want to modify a value in it, you must first
create a new parameter
group
or
copy an existing parameter
group,
modify it, and then apply the modified parameter group to your
cluster. For the new cluster parameter group and associated settings
to take effect, you must then reboot the instances in the cluster
without failover. For more information,
see
Modifying Amazon DocumentDB Cluster Parameter
Groups.
Creates a snapshot of a cluster.
Creates a new instance.
Creates a new subnet group.
subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
Creates an Amazon DocumentDB event notification subscription.
This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified
of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that
trigger the events, and you can provide a list of event categories
(EventCategories) for events that 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 are notified of all
the db-instance events for the specified source. If you specify a SourceType
but do not specify a SourceIdentifier, you receive notice of the events for
that source type for all your Amazon DocumentDB sources. If you do not specify
either the SourceType or the SourceIdentifier, you are notified of events
generated from all Amazon DocumentDB sources belonging to your customer account.
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.
The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
Deletes a previously provisioned cluster.
When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
Deletes a specified cluster parameter group.
The cluster parameter group to be deleted can't be associated with any clusters.
Deletes a cluster snapshot.
If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available state to be deleted.
Deletes a previously provisioned instance.
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an Amazon DocumentDB event notification subscription.
Deletes a global cluster.
The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
describe_db_cluster_parameter_groups(client, input, options \\ [])
View SourceReturns a list of DBClusterParameterGroup descriptions.
If a DBClusterParameterGroupName parameter is specified, the list contains
only the description of the specified cluster parameter group.
Returns the detailed parameter list for a particular cluster parameter group.
describe_db_cluster_snapshot_attributes(client, input, options \\ [])
View SourceReturns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute and a list
of IDs for the Amazon Web Services accounts that are authorized to copy or
restore the manual cluster snapshot. If all is included in the list of values
for the restore attribute, then the manual cluster snapshot is public and can
be copied or restored by all Amazon Web Services accounts.
Returns information about cluster snapshots.
This API operation supports pagination.
Returns information about provisioned Amazon DocumentDB clusters.
This API
operation supports pagination. For certain management features
such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon
Neptune. Use the filterName=engine,Values=docdb filter
parameter to return only Amazon DocumentDB clusters.
Returns a list of the available engines.
Returns information about provisioned Amazon DocumentDB instances.
This API supports pagination.
Returns a list of DBSubnetGroup descriptions.
If a
DBSubnetGroupName is specified, the list will contain only the descriptions of
the specified DBSubnetGroup.
describe_engine_default_cluster_parameters(client, input, options \\ [])
View SourceReturns the default engine and system parameter information for the cluster database engine.
Displays a list of categories for all event source types, or, if specified, for a specified source type.
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.
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
Returns information about Amazon DocumentDB global clusters.
This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describe_orderable_db_instance_options(client, input, options \\ [])
View SourceReturns a list of orderable instance options for the specified engine.
describe_pending_maintenance_actions(client, input, options \\ [])
View SourceReturns a list of resources (for example, instances) that have at least one pending maintenance action.
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.
Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
Lists all tags on an Amazon DocumentDB resource.
Modifies a setting for an Amazon DocumentDB cluster.
You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
Modifies the parameters of a 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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window
before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes
before creating your first cluster that uses that cluster parameter group as
the default parameter group. This allows Amazon DocumentDB to fully complete the
create action
before the parameter group is used as the default for a new cluster. This step
is
especially important for parameters that are critical when creating the default
database for a cluster, such as the character set for the default database
defined by the character_set_database parameter.
modify_db_cluster_snapshot_attribute(client, input, options \\ [])
View SourceAdds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts,
specify restore as the AttributeName, and use the ValuesToAdd parameter to
add a list of IDs of the Amazon Web Services accounts that are authorized to
restore the manual cluster snapshot. Use the value all to make the manual
cluster snapshot public, which means that it can be copied or restored by all
Amazon Web Services accounts. Do not add the all value for any manual cluster
snapshots that contain private information that you don't want available to all
Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can
be shared, but only by specifying a list of authorized Amazon Web Services
account IDs for the ValuesToAdd parameter. You can't use all as a value for
that parameter in this case.
Modifies settings for an instance.
You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
Modifies an existing subnet group.
subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
Modifies an existing Amazon DocumentDB event notification subscription.
Modify a setting for an Amazon DocumentDB global cluster.
You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
You might need to reboot your instance, usually for maintenance reasons.
For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
remove_source_identifier_from_subscription(client, input, options \\ [])
View SourceRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.
Removes metadata tags from an Amazon DocumentDB resource.
Modifies the parameters of a cluster parameter group to the default value.
To
reset specific parameters, submit a list of the following: ParameterName
and ApplyMethod. To reset the entire cluster parameter group, specify
the DBClusterParameterGroupName and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and
static parameters are set to pending-reboot to take effect on the next DB
instance reboot.
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
Restores a cluster to an arbitrary point in time.
Users can restore to any point in
time before LatestRestorableTime for up to
BackupRetentionPeriod days. The target cluster is created from the
source cluster with the same configuration as the original cluster, except that
the new cluster is created with the default security group.
Restarts the stopped cluster that is specified by DBClusterIdentifier.
For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
Stops the running cluster that is specified by DBClusterIdentifier.
The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.