aws_sdk_docdb

Struct Client

Source 
pub struct Client { /* private fields */ }
Expand description

Client for Amazon DocumentDB with MongoDB compatibility

Client for invoking operations on Amazon DocumentDB with MongoDB compatibility. Each operation on Amazon DocumentDB with MongoDB compatibility is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_docdb::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_docdb::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddSourceIdentifierToSubscription operation has a Client::add_source_identifier_to_subscription, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

ⓘ
let result = client.add_source_identifier_to_subscription()
    .subscription_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

ⓘ
let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn add_source_identifier_to_subscription( &self, ) -> AddSourceIdentifierToSubscriptionFluentBuilder

Constructs a fluent builder for the AddSourceIdentifierToSubscription operation.

Source§

impl Client

Source

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

Source§

impl Client

Source

pub fn apply_pending_maintenance_action( &self, ) -> ApplyPendingMaintenanceActionFluentBuilder

Constructs a fluent builder for the ApplyPendingMaintenanceAction operation.

Source§

impl Client

Source

pub fn copy_db_cluster_parameter_group( &self, ) -> CopyDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CopyDBClusterParameterGroup operation.

Source§

impl Client

Source

pub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the CopyDBClusterSnapshot operation.

  • The fluent builder is configurable:
    • source_db_cluster_snapshot_identifier(impl Into<String>) / set_source_db_cluster_snapshot_identifier(Option<String>):
      required: true

      The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

      Constraints:

      • Must specify a valid system snapshot in the available state.

      • If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.

      • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

      Example: my-cluster-snapshot1


    • target_db_cluster_snapshot_identifier(impl Into<String>) / set_target_db_cluster_snapshot_identifier(Option<String>):
      required: true

      The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster-snapshot2


    • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
      required: false

      The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

      If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don’t specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

      If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

      To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can’t use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

      If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.


    • pre_signed_url(impl Into<String>) / set_pre_signed_url(Option<String>):
      required: false

      The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

      If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

      The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

      • SourceRegion - The ID of the region that contains the snapshot to be copied.

      • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

      • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn’t case sensitive.


    • copy_tags(bool) / set_copy_tags(Option<bool>):
      required: false

      Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.


    • tags(Tag) / set_tags(Option<Vec::<Tag>>):
      required: false

      The tags to be assigned to the cluster snapshot.


  • On success, responds with CopyDbClusterSnapshotOutput with field(s):
  • On failure, responds with SdkError<CopyDBClusterSnapshotError>
Source§

impl Client

Source

pub fn create_db_cluster(&self) -> CreateDBClusterFluentBuilder

Constructs a fluent builder for the CreateDBCluster operation.

Source§

impl Client

Source

pub fn create_db_cluster_parameter_group( &self, ) -> CreateDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CreateDBClusterParameterGroup operation.

Source§

impl Client

Source

pub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the CreateDBClusterSnapshot operation.

Source§

impl Client

Source

pub fn create_db_instance(&self) -> CreateDBInstanceFluentBuilder

Constructs a fluent builder for the CreateDBInstance operation.

Source§

impl Client

Source

pub fn create_db_subnet_group(&self) -> CreateDBSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateDBSubnetGroup operation.

Source§

impl Client

Source

pub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder

Constructs a fluent builder for the CreateEventSubscription operation.

Source§

impl Client

Source

pub fn create_global_cluster(&self) -> CreateGlobalClusterFluentBuilder

Constructs a fluent builder for the CreateGlobalCluster operation.

Source§

impl Client

Source

pub fn delete_db_cluster(&self) -> DeleteDBClusterFluentBuilder

Constructs a fluent builder for the DeleteDBCluster operation.

Source§

impl Client

Source

pub fn delete_db_cluster_parameter_group( &self, ) -> DeleteDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteDBClusterParameterGroup operation.

Source§

impl Client

Source

pub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the DeleteDBClusterSnapshot operation.

Source§

impl Client

Source

pub fn delete_db_instance(&self) -> DeleteDBInstanceFluentBuilder

Constructs a fluent builder for the DeleteDBInstance operation.

Source§

impl Client

Source

pub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteDBSubnetGroup operation.

Source§

impl Client

Source

pub fn delete_event_subscription(&self) -> DeleteEventSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteEventSubscription operation.

Source§

impl Client

Source

pub fn delete_global_cluster(&self) -> DeleteGlobalClusterFluentBuilder

Constructs a fluent builder for the DeleteGlobalCluster operation.

Source§

impl Client

Source

pub fn describe_certificates(&self) -> DescribeCertificatesFluentBuilder

Constructs a fluent builder for the DescribeCertificates operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_db_cluster_parameter_groups( &self, ) -> DescribeDBClusterParameterGroupsFluentBuilder

Constructs a fluent builder for the DescribeDBClusterParameterGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_db_cluster_parameters( &self, ) -> DescribeDBClusterParametersFluentBuilder

Constructs a fluent builder for the DescribeDBClusterParameters operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_db_cluster_snapshot_attributes( &self, ) -> DescribeDBClusterSnapshotAttributesFluentBuilder

Constructs a fluent builder for the DescribeDBClusterSnapshotAttributes operation.

Source§

impl Client

Source

pub fn describe_db_cluster_snapshots( &self, ) -> DescribeDBClusterSnapshotsFluentBuilder

Constructs a fluent builder for the DescribeDBClusterSnapshots operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
      required: false

      The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can’t be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

      Constraints:

      • If provided, must match the identifier of an existing DBCluster.


    • db_cluster_snapshot_identifier(impl Into<String>) / set_db_cluster_snapshot_identifier(Option<String>):
      required: false

      A specific cluster snapshot identifier to describe. This parameter can’t be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

      Constraints:

      • If provided, must match the identifier of an existing DBClusterSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.


    • snapshot_type(impl Into<String>) / set_snapshot_type(Option<String>):
      required: false

      The type of cluster snapshots to be returned. You can specify one of the following values:

      • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

      • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

      • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

      • public - Return all cluster snapshots that have been marked as public.

      If you don’t specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

      The IncludeShared and IncludePublic parameters don’t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn’t apply when SnapshotType is set to shared. The IncludeShared parameter doesn’t apply when SnapshotType is set to public.


    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      This parameter is not currently supported.


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.


    • include_shared(bool) / set_include_shared(Option<bool>):
      required: false

      Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.


    • include_public(bool) / set_include_public(Option<bool>):
      required: false

      Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.


  • On success, responds with DescribeDbClusterSnapshotsOutput with field(s):
  • On failure, responds with SdkError<DescribeDBClusterSnapshotsError>
Source§

impl Client

Source

pub fn describe_db_clusters(&self) -> DescribeDBClustersFluentBuilder

Constructs a fluent builder for the DescribeDBClusters operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_db_engine_versions( &self, ) -> DescribeDBEngineVersionsFluentBuilder

Constructs a fluent builder for the DescribeDBEngineVersions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_db_instances(&self) -> DescribeDBInstancesFluentBuilder

Constructs a fluent builder for the DescribeDBInstances operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • db_instance_identifier(impl Into<String>) / set_db_instance_identifier(Option<String>):
      required: false

      The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn’t case sensitive.

      Constraints:

      • If provided, must match the identifier of an existing DBInstance.


    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      A filter that specifies one or more instances to describe.

      Supported filters:

      • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

      • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.


  • On success, responds with DescribeDbInstancesOutput with field(s):
  • On failure, responds with SdkError<DescribeDBInstancesError>
Source§

impl Client

Source

pub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroupsFluentBuilder

Constructs a fluent builder for the DescribeDBSubnetGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_engine_default_cluster_parameters( &self, ) -> DescribeEngineDefaultClusterParametersFluentBuilder

Constructs a fluent builder for the DescribeEngineDefaultClusterParameters operation.

Source§

impl Client

Source

pub fn describe_event_categories(&self) -> DescribeEventCategoriesFluentBuilder

Constructs a fluent builder for the DescribeEventCategories operation.

Source§

impl Client

Source

pub fn describe_event_subscriptions( &self, ) -> DescribeEventSubscriptionsFluentBuilder

Constructs a fluent builder for the DescribeEventSubscriptions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

Constructs a fluent builder for the DescribeEvents operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_global_clusters(&self) -> DescribeGlobalClustersFluentBuilder

Constructs a fluent builder for the DescribeGlobalClusters operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_orderable_db_instance_options( &self, ) -> DescribeOrderableDBInstanceOptionsFluentBuilder

Constructs a fluent builder for the DescribeOrderableDBInstanceOptions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_pending_maintenance_actions( &self, ) -> DescribePendingMaintenanceActionsFluentBuilder

Constructs a fluent builder for the DescribePendingMaintenanceActions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn failover_db_cluster(&self) -> FailoverDBClusterFluentBuilder

Constructs a fluent builder for the FailoverDBCluster operation.

Source§

impl Client

Source

pub fn failover_global_cluster(&self) -> FailoverGlobalClusterFluentBuilder

Constructs a fluent builder for the FailoverGlobalCluster operation.

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn modify_db_cluster(&self) -> ModifyDBClusterFluentBuilder

Constructs a fluent builder for the ModifyDBCluster operation.

  • The fluent builder is configurable:
    • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
      required: true

      The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.


    • new_db_cluster_identifier(impl Into<String>) / set_new_db_cluster_identifier(Option<String>):
      required: false

      The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster2


    • apply_immediately(bool) / set_apply_immediately(Option<bool>):
      required: false

      A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

      The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

      Default: false


    • backup_retention_period(i32) / set_backup_retention_period(Option<i32>):
      required: false

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.


    • db_cluster_parameter_group_name(impl Into<String>) / set_db_cluster_parameter_group_name(Option<String>):
      required: false

      The name of the cluster parameter group to use for the cluster.


    • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
      required: false

      A list of virtual private cloud (VPC) security groups that the cluster will belong to.


    • port(i32) / set_port(Option<i32>):
      required: false

      The port number on which the cluster accepts connections.

      Constraints: Must be a value from 1150 to 65535.

      Default: The same port as the original cluster.


    • master_user_password(impl Into<String>) / set_master_user_password(Option<String>):
      required: false

      The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (“), or the “at” symbol (@).

      Constraints: Must contain from 8 to 100 characters.


    • preferred_backup_window(impl Into<String>) / set_preferred_backup_window(Option<String>):
      required: false

      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.


    • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
      required: false

      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

      Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

      Constraints: Minimum 30-minute window.


    • cloudwatch_logs_export_configuration(CloudwatchLogsExportConfiguration) / set_cloudwatch_logs_export_configuration(Option<CloudwatchLogsExportConfiguration>):
      required: false

      The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.


    • engine_version(impl Into<String>) / set_engine_version(Option<String>):
      required: false

      The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

      To list all of the available engine versions for Amazon DocumentDB use the following command:

      aws docdb describe-db-engine-versions –engine docdb –query “DBEngineVersions[].EngineVersion”


    • allow_major_version_upgrade(bool) / set_allow_major_version_upgrade(Option<bool>):
      required: false

      A value that indicates whether major version upgrades are allowed.

      Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster’s current version.


    • deletion_protection(bool) / set_deletion_protection(Option<bool>):
      required: false

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.


    • storage_type(impl Into<String>) / set_storage_type(Option<String>):
      required: false

      The storage type to associate with the DB cluster.

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard


    • manage_master_user_password(bool) / set_manage_master_user_password(Option<bool>):
      required: false

      Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the cluster doesn’t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can’t specify MasterUserPassword. If the cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by MasterUserPassword.


    • master_user_secret_kms_key_id(impl Into<String>) / set_master_user_secret_kms_key_id(Option<String>):
      required: false

      The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if both of the following conditions are met:

      • The cluster doesn’t manage the master user password in Amazon Web Services Secrets Manager. If the cluster already manages the master user password in Amazon Web Services Secrets Manager, you can’t change the KMS key that is used to encrypt the secret.

      • You are enabling ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don’t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.


    • rotate_master_user_password(bool) / set_rotate_master_user_password(Option<bool>):
      required: false

      Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

      This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

      Constraint: You must apply the change immediately when rotating the master user password.


  • On success, responds with ModifyDbClusterOutput with field(s):
  • On failure, responds with SdkError<ModifyDBClusterError>
Source§

impl Client

Source

pub fn modify_db_cluster_parameter_group( &self, ) -> ModifyDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ModifyDBClusterParameterGroup operation.

Source§

impl Client

Source

pub fn modify_db_cluster_snapshot_attribute( &self, ) -> ModifyDBClusterSnapshotAttributeFluentBuilder

Constructs a fluent builder for the ModifyDBClusterSnapshotAttribute operation.

Source§

impl Client

Source

pub fn modify_db_instance(&self) -> ModifyDBInstanceFluentBuilder

Constructs a fluent builder for the ModifyDBInstance operation.

Source§

impl Client

Source

pub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroupFluentBuilder

Constructs a fluent builder for the ModifyDBSubnetGroup operation.

Source§

impl Client

Source

pub fn modify_event_subscription(&self) -> ModifyEventSubscriptionFluentBuilder

Constructs a fluent builder for the ModifyEventSubscription operation.

Source§

impl Client

Source

pub fn modify_global_cluster(&self) -> ModifyGlobalClusterFluentBuilder

Constructs a fluent builder for the ModifyGlobalCluster operation.

Source§

impl Client

Source

pub fn reboot_db_instance(&self) -> RebootDBInstanceFluentBuilder

Constructs a fluent builder for the RebootDBInstance operation.

Source§

impl Client

Source

pub fn remove_from_global_cluster(&self) -> RemoveFromGlobalClusterFluentBuilder

Constructs a fluent builder for the RemoveFromGlobalCluster operation.

Source§

impl Client

Source

pub fn remove_source_identifier_from_subscription( &self, ) -> RemoveSourceIdentifierFromSubscriptionFluentBuilder

Constructs a fluent builder for the RemoveSourceIdentifierFromSubscription operation.

Source§

impl Client

Source

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

Source§

impl Client

Source

pub fn reset_db_cluster_parameter_group( &self, ) -> ResetDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ResetDBClusterParameterGroup operation.

Source§

impl Client

Source

pub fn restore_db_cluster_from_snapshot( &self, ) -> RestoreDBClusterFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreDBClusterFromSnapshot operation.

Source§

impl Client

Source

pub fn restore_db_cluster_to_point_in_time( &self, ) -> RestoreDBClusterToPointInTimeFluentBuilder

Constructs a fluent builder for the RestoreDBClusterToPointInTime operation.

Source§

impl Client

Source

pub fn start_db_cluster(&self) -> StartDBClusterFluentBuilder

Constructs a fluent builder for the StartDBCluster operation.

Source§

impl Client

Source

pub fn stop_db_cluster(&self) -> StopDBClusterFluentBuilder

Constructs a fluent builder for the StopDBCluster operation.

Source§

impl Client

Source

pub fn switchover_global_cluster(&self) -> SwitchoverGlobalClusterFluentBuilder

Constructs a fluent builder for the SwitchoverGlobalCluster operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Waiters for Client

Source§

fn wait_until_db_instance_available(&self) -> DbInstanceAvailableFluentBuilder

Wait for db_instance_available
Source§

fn wait_until_db_instance_deleted(&self) -> DbInstanceDeletedFluentBuilder

Wait for db_instance_deleted

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,