Struct DocdbClient 

pub struct DocdbClient { /* private fields */ }

A client for the Amazon DocDB API.

Implementations

impl DocdbClient

pub fn new(region: Region) -> DocdbClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: Region, ) -> DocdbClient

where P: ProvideAwsCredentials + Send + Sync + 'static, D: DispatchSignedRequest + Send + Sync + 'static,

pub fn new_with_client(client: Client, region: Region) -> DocdbClient

Trait Implementations

impl Clone for DocdbClient

fn clone(&self) -> DocdbClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Docdb for DocdbClient

fn add_tags_to_resource<'life0, 'async_trait>( &'life0 self, input: AddTagsToResourceMessage, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AddTagsToResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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 AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

fn apply_pending_maintenance_action<'life0, 'async_trait>( &'life0 self, input: ApplyPendingMaintenanceActionMessage, ) -> Pin<Box<dyn Future<Output = Result<ApplyPendingMaintenanceActionResult, RusotoError<ApplyPendingMaintenanceActionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

fn copy_db_cluster_parameter_group<'life0, 'async_trait>( &'life0 self, input: CopyDBClusterParameterGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<CopyDBClusterParameterGroupResult, RusotoError<CopyDBClusterParameterGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Copies the specified cluster parameter group.

fn copy_db_cluster_snapshot<'life0, 'async_trait>( &'life0 self, input: CopyDBClusterSnapshotMessage, ) -> Pin<Box<dyn Future<Output = Result<CopyDBClusterSnapshotResult, RusotoError<CopyDBClusterSnapshotError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn create_db_cluster<'life0, 'async_trait>( &'life0 self, input: CreateDBClusterMessage, ) -> Pin<Box<dyn Future<Output = Result<CreateDBClusterResult, RusotoError<CreateDBClusterError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new Amazon DocumentDB cluster.

fn create_db_cluster_parameter_group<'life0, 'async_trait>( &'life0 self, input: CreateDBClusterParameterGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<CreateDBClusterParameterGroupResult, RusotoError<CreateDBClusterParameterGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn create_db_cluster_snapshot<'life0, 'async_trait>( &'life0 self, input: CreateDBClusterSnapshotMessage, ) -> Pin<Box<dyn Future<Output = Result<CreateDBClusterSnapshotResult, RusotoError<CreateDBClusterSnapshotError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a snapshot of a cluster.

fn create_db_instance<'life0, 'async_trait>( &'life0 self, input: CreateDBInstanceMessage, ) -> Pin<Box<dyn Future<Output = Result<CreateDBInstanceResult, RusotoError<CreateDBInstanceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new instance.

fn create_db_subnet_group<'life0, 'async_trait>( &'life0 self, input: CreateDBSubnetGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<CreateDBSubnetGroupResult, RusotoError<CreateDBSubnetGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

fn delete_db_cluster<'life0, 'async_trait>( &'life0 self, input: DeleteDBClusterMessage, ) -> Pin<Box<dyn Future<Output = Result<DeleteDBClusterResult, RusotoError<DeleteDBClusterError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn delete_db_cluster_parameter_group<'life0, 'async_trait>( &'life0 self, input: DeleteDBClusterParameterGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteDBClusterParameterGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

fn delete_db_cluster_snapshot<'life0, 'async_trait>( &'life0 self, input: DeleteDBClusterSnapshotMessage, ) -> Pin<Box<dyn Future<Output = Result<DeleteDBClusterSnapshotResult, RusotoError<DeleteDBClusterSnapshotError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn delete_db_instance<'life0, 'async_trait>( &'life0 self, input: DeleteDBInstanceMessage, ) -> Pin<Box<dyn Future<Output = Result<DeleteDBInstanceResult, RusotoError<DeleteDBInstanceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes a previously provisioned instance.

fn delete_db_subnet_group<'life0, 'async_trait>( &'life0 self, input: DeleteDBSubnetGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteDBSubnetGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes a subnet group.

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

fn describe_certificates<'life0, 'async_trait>( &'life0 self, input: DescribeCertificatesMessage, ) -> Pin<Box<dyn Future<Output = Result<CertificateMessage, RusotoError<DescribeCertificatesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.

fn describe_db_cluster_parameter_groups<'life0, 'async_trait>( &'life0 self, input: DescribeDBClusterParameterGroupsMessage, ) -> Pin<Box<dyn Future<Output = Result<DBClusterParameterGroupsMessage, RusotoError<DescribeDBClusterParameterGroupsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

fn describe_db_cluster_parameters<'life0, 'async_trait>( &'life0 self, input: DescribeDBClusterParametersMessage, ) -> Pin<Box<dyn Future<Output = Result<DBClusterParameterGroupDetails, RusotoError<DescribeDBClusterParametersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn describe_db_cluster_snapshot_attributes<'life0, 'async_trait>( &'life0 self, input: DescribeDBClusterSnapshotAttributesMessage, ) -> Pin<Box<dyn Future<Output = Result<DescribeDBClusterSnapshotAttributesResult, RusotoError<DescribeDBClusterSnapshotAttributesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share 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 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 AWS accounts.

fn describe_db_cluster_snapshots<'life0, 'async_trait>( &'life0 self, input: DescribeDBClusterSnapshotsMessage, ) -> Pin<Box<dyn Future<Output = Result<DBClusterSnapshotMessage, RusotoError<DescribeDBClusterSnapshotsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns information about cluster snapshots. This API operation supports pagination.

fn describe_db_clusters<'life0, 'async_trait>( &'life0 self, input: DescribeDBClustersMessage, ) -> Pin<Box<dyn Future<Output = Result<DBClusterMessage, RusotoError<DescribeDBClustersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn describe_db_engine_versions<'life0, 'async_trait>( &'life0 self, input: DescribeDBEngineVersionsMessage, ) -> Pin<Box<dyn Future<Output = Result<DBEngineVersionMessage, RusotoError<DescribeDBEngineVersionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of the available engines.

fn describe_db_instances<'life0, 'async_trait>( &'life0 self, input: DescribeDBInstancesMessage, ) -> Pin<Box<dyn Future<Output = Result<DBInstanceMessage, RusotoError<DescribeDBInstancesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

fn describe_db_subnet_groups<'life0, 'async_trait>( &'life0 self, input: DescribeDBSubnetGroupsMessage, ) -> Pin<Box<dyn Future<Output = Result<DBSubnetGroupMessage, RusotoError<DescribeDBSubnetGroupsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

fn describe_engine_default_cluster_parameters<'life0, 'async_trait>( &'life0 self, input: DescribeEngineDefaultClusterParametersMessage, ) -> Pin<Box<dyn Future<Output = Result<DescribeEngineDefaultClusterParametersResult, RusotoError<DescribeEngineDefaultClusterParametersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn describe_event_categories<'life0, 'async_trait>( &'life0 self, input: DescribeEventCategoriesMessage, ) -> Pin<Box<dyn Future<Output = Result<EventCategoriesMessage, RusotoError<DescribeEventCategoriesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Displays a list of categories for all event source types, or, if specified, for a specified source type.

fn describe_events<'life0, 'async_trait>( &'life0 self, input: DescribeEventsMessage, ) -> Pin<Box<dyn Future<Output = Result<EventsMessage, RusotoError<DescribeEventsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn describe_orderable_db_instance_options<'life0, 'async_trait>( &'life0 self, input: DescribeOrderableDBInstanceOptionsMessage, ) -> Pin<Box<dyn Future<Output = Result<OrderableDBInstanceOptionsMessage, RusotoError<DescribeOrderableDBInstanceOptionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn describe_pending_maintenance_actions<'life0, 'async_trait>( &'life0 self, input: DescribePendingMaintenanceActionsMessage, ) -> Pin<Box<dyn Future<Output = Result<PendingMaintenanceActionsMessage, RusotoError<DescribePendingMaintenanceActionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

fn failover_db_cluster<'life0, 'async_trait>( &'life0 self, input: FailoverDBClusterMessage, ) -> Pin<Box<dyn Future<Output = Result<FailoverDBClusterResult, RusotoError<FailoverDBClusterError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceMessage, ) -> Pin<Box<dyn Future<Output = Result<TagListMessage, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists all tags on an Amazon DocumentDB resource.

fn modify_db_cluster<'life0, 'async_trait>( &'life0 self, input: ModifyDBClusterMessage, ) -> Pin<Box<dyn Future<Output = Result<ModifyDBClusterResult, RusotoError<ModifyDBClusterError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn modify_db_cluster_parameter_group<'life0, 'async_trait>( &'life0 self, input: ModifyDBClusterParameterGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<DBClusterParameterGroupNameMessage, RusotoError<ModifyDBClusterParameterGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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 charactersetdatabase parameter.

fn modify_db_cluster_snapshot_attribute<'life0, 'async_trait>( &'life0 self, input: ModifyDBClusterSnapshotAttributeMessage, ) -> Pin<Box<dyn Future<Output = Result<ModifyDBClusterSnapshotAttributeResult, RusotoError<ModifyDBClusterSnapshotAttributeError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual 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 cluster snapshot. Use the value all to make the manual 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 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.

fn modify_db_instance<'life0, 'async_trait>( &'life0 self, input: ModifyDBInstanceMessage, ) -> Pin<Box<dyn Future<Output = Result<ModifyDBInstanceResult, RusotoError<ModifyDBInstanceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn modify_db_subnet_group<'life0, 'async_trait>( &'life0 self, input: ModifyDBSubnetGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<ModifyDBSubnetGroupResult, RusotoError<ModifyDBSubnetGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

fn reboot_db_instance<'life0, 'async_trait>( &'life0 self, input: RebootDBInstanceMessage, ) -> Pin<Box<dyn Future<Output = Result<RebootDBInstanceResult, RusotoError<RebootDBInstanceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn remove_tags_from_resource<'life0, 'async_trait>( &'life0 self, input: RemoveTagsFromResourceMessage, ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<RemoveTagsFromResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes metadata tags from an Amazon DocumentDB resource.

fn reset_db_cluster_parameter_group<'life0, 'async_trait>( &'life0 self, input: ResetDBClusterParameterGroupMessage, ) -> Pin<Box<dyn Future<Output = Result<DBClusterParameterGroupNameMessage, RusotoError<ResetDBClusterParameterGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn restore_db_cluster_from_snapshot<'life0, 'async_trait>( &'life0 self, input: RestoreDBClusterFromSnapshotMessage, ) -> Pin<Box<dyn Future<Output = Result<RestoreDBClusterFromSnapshotResult, RusotoError<RestoreDBClusterFromSnapshotError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn restore_db_cluster_to_point_in_time<'life0, 'async_trait>( &'life0 self, input: RestoreDBClusterToPointInTimeMessage, ) -> Pin<Box<dyn Future<Output = Result<RestoreDBClusterToPointInTimeResult, RusotoError<RestoreDBClusterToPointInTimeError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn start_db_cluster<'life0, 'async_trait>( &'life0 self, input: StartDBClusterMessage, ) -> Pin<Box<dyn Future<Output = Result<StartDBClusterResult, RusotoError<StartDBClusterError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

fn stop_db_cluster<'life0, 'async_trait>( &'life0 self, input: StopDBClusterMessage, ) -> Pin<Box<dyn Future<Output = Result<StopDBClusterResult, RusotoError<StopDBClusterError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.