Struct aws_sdk_docdb::Client

pub struct Client { /* private fields */ }

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

Implementations

impl Client

pub fn add_source_identifier_to_subscription( &self ) -> AddSourceIdentifierToSubscriptionFluentBuilder

Constructs a fluent builder for the AddSourceIdentifierToSubscription operation.

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

    The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

    
    
  • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):
    required: true
    

    The identifier of the event source to be added:

    • If the source type is an instance, a DBInstanceIdentifier must be provided.

    • If the source type is a security group, a DBSecurityGroupName must be provided.

    • If the source type is a parameter group, a DBParameterGroupName must be provided.

    • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

    
    
• On success, responds with AddSourceIdentifierToSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Detailed information about an event to which you have subscribed.

• On failure, responds with SdkError<AddSourceIdentifierToSubscriptionError>

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

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

    The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

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

    The tags to be assigned to the Amazon DocumentDB resource.

    
    
• On success, responds with AddTagsToResourceOutput
• On failure, responds with SdkError<AddTagsToResourceError>

impl Client

pub fn apply_pending_maintenance_action( &self ) -> ApplyPendingMaintenanceActionFluentBuilder

Constructs a fluent builder for the ApplyPendingMaintenanceAction operation.

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

    The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

    
    
  • apply_action(impl Into<String>) / set_apply_action(Option<String>):
    required: true
    

    The pending maintenance action to apply to this resource.

    Valid values: system-update, db-upgrade

    
    
  • opt_in_type(impl Into<String>) / set_opt_in_type(Option<String>):
    required: true
    

    A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can’t be undone.

    Valid values:

    • immediate - Apply the maintenance action immediately.

    • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

    • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

    
    
• On success, responds with ApplyPendingMaintenanceActionOutput with field(s):
  • resource_pending_maintenance_actions(Option<ResourcePendingMaintenanceActions>):

    Represents the output of ApplyPendingMaintenanceAction.

• On failure, responds with SdkError<ApplyPendingMaintenanceActionError>

impl Client

pub fn copy_db_cluster_parameter_group( &self ) -> CopyDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CopyDBClusterParameterGroup operation.

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

    The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

    Constraints:

    • Must specify a valid cluster parameter group.

    • If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

    • If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

    
    
  • target_db_cluster_parameter_group_identifier(impl Into<String>) / set_target_db_cluster_parameter_group_identifier(Option<String>):
    required: true
    

    The identifier for the copied cluster parameter group.

    Constraints:

    • Cannot be null, empty, or blank.

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

    • The first character must be a letter.

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

    Example: my-cluster-param-group1

    
    
  • target_db_cluster_parameter_group_description(impl Into<String>) / set_target_db_cluster_parameter_group_description(Option<String>):
    required: true
    

    A description for the copied cluster parameter group.

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

    The tags that are to be assigned to the parameter group.

    
    
• On success, responds with CopyDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group(Option<DbClusterParameterGroup>):

    Detailed information about a cluster parameter group.

• On failure, responds with SdkError<CopyDBClusterParameterGroupError>

impl Client

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):
  • db_cluster_snapshot(Option<DbClusterSnapshot>):

    Detailed information about a cluster snapshot.

• On failure, responds with SdkError<CopyDBClusterSnapshotError>

impl Client

pub fn create_db_cluster(&self) -> CreateDBClusterFluentBuilder

Constructs a fluent builder for the CreateDBCluster operation.

• The fluent builder is configurable:
  • availability_zones(impl Into<String>) / set_availability_zones(Option<Vec::<String>>):
    required: false
    

    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    
    
  • 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_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The cluster identifier. This parameter 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-cluster

    
    
  • 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 associate with this cluster.

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

    A list of EC2 VPC security groups to associate with this cluster.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    A subnet group to associate with this cluster.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The name of the database engine to be used for this cluster.

    Valid values: docdb

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

    The version number of the database engine to use. The –engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

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

    The port number on which the instances in the cluster accept connections.

    
    
  • master_username(impl Into<String>) / set_master_username(Option<String>):
    required: false
    

    The name of the master user for the cluster.

    Constraints:

    • Must be from 1 to 63 letters or numbers.

    • The first character must be a letter.

    • Cannot be a reserved word for the chosen database engine.

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

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

    The tags to be assigned to the cluster.

    
    
  • storage_encrypted(bool) / set_storage_encrypted(Option<bool>):
    required: false
    

    Specifies whether the cluster is encrypted.

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

    The KMS key identifier for an encrypted cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If an encryption key is not specified in KmsKeyId:

    • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

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

    Not currently supported.

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

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

    
    
  • global_cluster_identifier(impl Into<String>) / set_global_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier of the new global cluster.

    
    
  • 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

    When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn’t returned when you set it to standard.

    
    
• On success, responds with CreateDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<CreateDBClusterError>

impl Client

pub fn create_db_cluster_parameter_group( &self ) -> CreateDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CreateDBClusterParameterGroup operation.

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

    The name of the cluster parameter group.

    Constraints:

    • Must not match the name of an existing DBClusterParameterGroup.

    This value is stored as a lowercase string.

    
    
  • db_parameter_group_family(impl Into<String>) / set_db_parameter_group_family(Option<String>):
    required: true
    

    The cluster parameter group family name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    The description for the cluster parameter group.

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

    The tags to be assigned to the cluster parameter group.

    
    
• On success, responds with CreateDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group(Option<DbClusterParameterGroup>):

    Detailed information about a cluster parameter group.

• On failure, responds with SdkError<CreateDBClusterParameterGroupError>

impl Client

pub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the CreateDBClusterSnapshot operation.

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

    The identifier of the cluster snapshot. This parameter 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-cluster-snapshot1

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    Example: my-cluster

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

    The tags to be assigned to the cluster snapshot.

    
    
• On success, responds with CreateDbClusterSnapshotOutput with field(s):
  • db_cluster_snapshot(Option<DbClusterSnapshot>):

    Detailed information about a cluster snapshot.

• On failure, responds with SdkError<CreateDBClusterSnapshotError>

impl Client

pub fn create_db_instance(&self) -> CreateDBInstanceFluentBuilder

Constructs a fluent builder for the CreateDBInstance operation.

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

    The instance identifier. This parameter 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: mydbinstance

    
    
  • db_instance_class(impl Into<String>) / set_db_instance_class(Option<String>):
    required: true
    

    The compute and memory capacity of the instance; for example, db.r5.large.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The name of the database engine to be used for this instance.

    Valid value: docdb

    
    
  • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):
    required: false
    

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region.

    Example: us-east-1d

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

    The time range each week 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.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

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

    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster that the instance will belong to.

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    
    
  • promotion_tier(i32) / set_promotion_tier(Option<i32>):
    required: false
    

    A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid values: 0-15

    
    
  • enable_performance_insights(bool) / set_enable_performance_insights(Option<bool>):
    required: false
    

    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

    
    
  • performance_insights_kms_key_id(impl Into<String>) / set_performance_insights_kms_key_id(Option<String>):
    required: false
    

    The KMS key identifier for encryption of Performance Insights data.

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. 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.

    
    
  • ca_certificate_identifier(impl Into<String>) / set_ca_certificate_identifier(Option<String>):
    required: false
    

    The CA certificate identifier to use for the DB instance’s server certificate.

    For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

    
    
• On success, responds with CreateDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Detailed information about an instance.

• On failure, responds with SdkError<CreateDBInstanceError>

impl Client

pub fn create_db_subnet_group(&self) -> CreateDBSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateDBSubnetGroup operation.

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

    The name for the subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    Example: mySubnetgroup

    
    
  • db_subnet_group_description(impl Into<String>) / set_db_subnet_group_description(Option<String>):
    required: true
    

    The description for the subnet group.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The Amazon EC2 subnet IDs for the subnet group.

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

    The tags to be assigned to the subnet group.

    
    
• On success, responds with CreateDbSubnetGroupOutput with field(s):
  • db_subnet_group(Option<DbSubnetGroup>):

    Detailed information about a subnet group.

• On failure, responds with SdkError<CreateDBSubnetGroupError>

impl Client

pub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder

Constructs a fluent builder for the CreateEventSubscription operation.

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

    The name of the subscription.

    Constraints: The name must be fewer than 255 characters.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

    
    
  • source_type(impl Into<String>) / set_source_type(Option<String>):
    required: false
    

    The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

    Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

    
    
  • event_categories(impl Into<String>) / set_event_categories(Option<Vec::<String>>):
    required: false
    

    A list of event categories for a SourceType that you want to subscribe to.

    
    
  • source_ids(impl Into<String>) / set_source_ids(Option<Vec::<String>>):
    required: false
    

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are provided, SourceType must also be provided.

    • If the source type is an instance, a DBInstanceIdentifier must be provided.

    • If the source type is a security group, a DBSecurityGroupName must be provided.

    • If the source type is a parameter group, a DBParameterGroupName must be provided.

    • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

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

    The tags to be assigned to the event subscription.

    
    
• On success, responds with CreateEventSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Detailed information about an event to which you have subscribed.

• On failure, responds with SdkError<CreateEventSubscriptionError>

impl Client

pub fn create_global_cluster(&self) -> CreateGlobalClusterFluentBuilder

Constructs a fluent builder for the CreateGlobalCluster operation.

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

    The cluster identifier of the new global cluster.

    
    
  • source_db_cluster_identifier(impl Into<String>) / set_source_db_cluster_identifier(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The name of the database engine to be used for this cluster.

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

    The engine version of the global cluster.

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

    The deletion protection setting for the new global cluster. The global cluster can’t be deleted when deletion protection is enabled.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: false
    

    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

    
    
  • storage_encrypted(bool) / set_storage_encrypted(Option<bool>):
    required: false
    

    The storage encryption setting for the new global cluster.

    
    
• On success, responds with CreateGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    A data type representing an Amazon DocumentDB global cluster.

• On failure, responds with SdkError<CreateGlobalClusterError>

impl Client

pub fn delete_db_cluster(&self) -> DeleteDBClusterFluentBuilder

Constructs a fluent builder for the DeleteDBCluster 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 to be deleted. This parameter isn’t case sensitive.

    Constraints:

    • Must match an existing DBClusterIdentifier.

    
    
  • skip_final_snapshot(bool) / set_skip_final_snapshot(Option<bool>):
    required: false
    

    Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

    If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

    Default: false

    
    
  • final_db_snapshot_identifier(impl Into<String>) / set_final_db_snapshot_identifier(Option<String>):
    required: false
    

    The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

    • Must be from 1 to 255 letters, numbers, or hyphens.

    • The first character must be a letter.

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

    
    
• On success, responds with DeleteDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<DeleteDBClusterError>

impl Client

pub fn delete_db_cluster_parameter_group( &self ) -> DeleteDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteDBClusterParameterGroup operation.

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

    The name of the cluster parameter group.

    Constraints:

    • Must be the name of an existing cluster parameter group.

    • You can’t delete a default cluster parameter group.

    • Cannot be associated with any clusters.

    
    
• On success, responds with DeleteDbClusterParameterGroupOutput
• On failure, responds with SdkError<DeleteDBClusterParameterGroupError>

impl Client

pub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the DeleteDBClusterSnapshot operation.

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

    The identifier of the cluster snapshot to delete.

    Constraints: Must be the name of an existing cluster snapshot in the available state.

    
    
• On success, responds with DeleteDbClusterSnapshotOutput with field(s):
  • db_cluster_snapshot(Option<DbClusterSnapshot>):

    Detailed information about a cluster snapshot.

• On failure, responds with SdkError<DeleteDBClusterSnapshotError>

impl Client

pub fn delete_db_instance(&self) -> DeleteDBInstanceFluentBuilder

Constructs a fluent builder for the DeleteDBInstance operation.

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

    The instance identifier for the instance to be deleted. This parameter isn’t case sensitive.

    Constraints:

    • Must match the name of an existing instance.

    
    
• On success, responds with DeleteDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Detailed information about an instance.

• On failure, responds with SdkError<DeleteDBInstanceError>

impl Client

pub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteDBSubnetGroup operation.

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

    The name of the database subnet group to delete.

    You can’t delete the default subnet group.

    Constraints:

    Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    
    
• On success, responds with DeleteDbSubnetGroupOutput
• On failure, responds with SdkError<DeleteDBSubnetGroupError>

impl Client

pub fn delete_event_subscription(&self) -> DeleteEventSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteEventSubscription operation.

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

    The name of the Amazon DocumentDB event notification subscription that you want to delete.

    
    
• On success, responds with DeleteEventSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Detailed information about an event to which you have subscribed.

• On failure, responds with SdkError<DeleteEventSubscriptionError>

impl Client

pub fn delete_global_cluster(&self) -> DeleteGlobalClusterFluentBuilder

Constructs a fluent builder for the DeleteGlobalCluster operation.

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

    The cluster identifier of the global cluster being deleted.

    
    
• On success, responds with DeleteGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    A data type representing an Amazon DocumentDB global cluster.

• On failure, responds with SdkError<DeleteGlobalClusterError>

impl Client

pub fn describe_certificates(&self) -> DescribeCertificatesFluentBuilder

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

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

    The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

    Constraints

    • Must match an existing CertificateIdentifier.

    
    
  • 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 called a 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 DescribeCertificates 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 DescribeCertificatesOutput with field(s):
  • certificates(Option<Vec::<Certificate>>):

    A list of certificates for this Amazon Web Services account.

  • marker(Option<String>):

    An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

• On failure, responds with SdkError<DescribeCertificatesError>

impl Client

pub fn describe_db_cluster_parameter_groups( &self ) -> DescribeDBClusterParameterGroupsFluentBuilder

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

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

    The name of a specific cluster parameter group to return details for.

    Constraints:

    • If provided, must match the name of an existing DBClusterParameterGroup.

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

    
    
• On success, responds with DescribeDbClusterParameterGroupsOutput with field(s):
  • marker(Option<String>):

    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.

  • db_cluster_parameter_groups(Option<Vec::<DbClusterParameterGroup>>):

    A list of cluster parameter groups.

• On failure, responds with SdkError<DescribeDBClusterParameterGroupsError>

impl Client

pub fn describe_db_cluster_parameters( &self ) -> DescribeDBClusterParametersFluentBuilder

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

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

    The name of a specific cluster parameter group to return parameter details for.

    Constraints:

    • If provided, must match the name of an existing DBClusterParameterGroup.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

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

    
    
• On success, responds with DescribeDbClusterParametersOutput with field(s):
  • parameters(Option<Vec::<Parameter>>):

    Provides a list of parameters for the cluster parameter group.

  • marker(Option<String>):

    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 failure, responds with SdkError<DescribeDBClusterParametersError>

impl Client

pub fn describe_db_cluster_snapshot_attributes( &self ) -> DescribeDBClusterSnapshotAttributesFluentBuilder

Constructs a fluent builder for the DescribeDBClusterSnapshotAttributes operation.

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

    The identifier for the cluster snapshot to describe the attributes for.

    
    
• On success, responds with DescribeDbClusterSnapshotAttributesOutput with field(s):
  • db_cluster_snapshot_attributes_result(Option<DbClusterSnapshotAttributesResult>):

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

• On failure, responds with SdkError<DescribeDBClusterSnapshotAttributesError>

impl Client

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):
  • marker(Option<String>):

    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.

  • db_cluster_snapshots(Option<Vec::<DbClusterSnapshot>>):

    Provides a list of cluster snapshots.

• On failure, responds with SdkError<DescribeDBClusterSnapshotsError>

impl Client

pub fn describe_db_clusters(&self) -> DescribeDBClustersFluentBuilder

Constructs a fluent builder for the DescribeDBClusters 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 user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn’t case sensitive.

    Constraints:

    • If provided, must match an existing DBClusterIdentifier.

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

    A filter that specifies one or more clusters to describe.

    Supported filters:

    • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters 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 DescribeDbClustersOutput with field(s):
  • marker(Option<String>):

    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.

  • db_clusters(Option<Vec::<DbCluster>>):

    A list of clusters.

• On failure, responds with SdkError<DescribeDBClustersError>

impl Client

pub fn describe_db_engine_versions( &self ) -> DescribeDBEngineVersionsFluentBuilder

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

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

    The database engine to return.

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

    The database engine version to return.

    Example: 3.6.0

    
    
  • db_parameter_group_family(impl Into<String>) / set_db_parameter_group_family(Option<String>):
    required: false
    

    The name of a specific parameter group family to return details for.

    Constraints:

    • If provided, must match an existing DBParameterGroupFamily.

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

    
    
  • default_only(bool) / set_default_only(Option<bool>):
    required: false
    

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

    
    
  • list_supported_character_sets(bool) / set_list_supported_character_sets(Option<bool>):
    required: false
    

    If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

    
    
  • list_supported_timezones(bool) / set_list_supported_timezones(Option<bool>):
    required: false
    

    If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

    
    
• On success, responds with DescribeDbEngineVersionsOutput with field(s):
  • marker(Option<String>):

    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.

  • db_engine_versions(Option<Vec::<DbEngineVersion>>):

    Detailed information about one or more engine versions.

• On failure, responds with SdkError<DescribeDBEngineVersionsError>

impl Client

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):
  • marker(Option<String>):

    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.

  • db_instances(Option<Vec::<DbInstance>>):

    Detailed information about one or more instances.

• On failure, responds with SdkError<DescribeDBInstancesError>

impl Client

pub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroupsFluentBuilder

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

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

    The name of the subnet group to return details for.

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

    
    
• On success, responds with DescribeDbSubnetGroupsOutput with field(s):
  • marker(Option<String>):

    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.

  • db_subnet_groups(Option<Vec::<DbSubnetGroup>>):

    Detailed information about one or more subnet groups.

• On failure, responds with SdkError<DescribeDBSubnetGroupsError>

impl Client

pub fn describe_engine_default_cluster_parameters( &self ) -> DescribeEngineDefaultClusterParametersFluentBuilder

Constructs a fluent builder for the DescribeEngineDefaultClusterParameters operation.

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

    The name of the cluster parameter group family to return the engine parameter information for.

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

    
    
• On success, responds with DescribeEngineDefaultClusterParametersOutput with field(s):
  • engine_defaults(Option<EngineDefaults>):

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

• On failure, responds with SdkError<DescribeEngineDefaultClusterParametersError>

impl Client

pub fn describe_event_categories(&self) -> DescribeEventCategoriesFluentBuilder

Constructs a fluent builder for the DescribeEventCategories operation.

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

    The type of source that is generating the events.

    Valid values: db-instance, db-parameter-group, db-security-group

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

    This parameter is not currently supported.

    
    
• On success, responds with DescribeEventCategoriesOutput with field(s):
  • event_categories_map_list(Option<Vec::<EventCategoriesMap>>):

    A list of event category maps.

• On failure, responds with SdkError<DescribeEventCategoriesError>

impl Client

pub fn describe_event_subscriptions( &self ) -> DescribeEventSubscriptionsFluentBuilder

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

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

    The name of the Amazon DocumentDB event notification subscription that you want to describe.

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

    
    
• On success, responds with DescribeEventSubscriptionsOutput with field(s):
  • marker(Option<String>):

    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.

  • event_subscriptions_list(Option<Vec::<EventSubscription>>):

    A list of event subscriptions.

• On failure, responds with SdkError<DescribeEventSubscriptionsError>

impl Client

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

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

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

    The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

    Constraints:

    • If SourceIdentifier is provided, SourceType must also be provided.

    • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

    • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

    • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

    • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

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

    
    
  • source_type(SourceType) / set_source_type(Option<SourceType>):
    required: false
    

    The event source to retrieve events for. If no value is specified, all events are returned.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

    Example: 2009-07-08T18:00Z

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

    Example: 2009-07-08T18:00Z

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of minutes to retrieve events for.

    Default: 60

    
    
  • event_categories(impl Into<String>) / set_event_categories(Option<Vec::<String>>):
    required: false
    

    A list of event categories that trigger notifications for an event notification subscription.

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

    
    
• On success, responds with DescribeEventsOutput with field(s):
  • marker(Option<String>):

    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.

  • events(Option<Vec::<Event>>):

    Detailed information about one or more events.

• On failure, responds with SdkError<DescribeEventsError>

impl Client

pub fn describe_global_clusters(&self) -> DescribeGlobalClustersFluentBuilder

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

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

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

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

    A filter that specifies one or more global DB clusters to describe.

    Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters 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 called a marker is included in the response so that you can retrieve the remaining results.

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

    An optional pagination token provided by a previous DescribeGlobalClusters 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 DescribeGlobalClustersOutput with field(s):
  • marker(Option<String>):

  • global_clusters(Option<Vec::<GlobalCluster>>):

• On failure, responds with SdkError<DescribeGlobalClustersError>

impl Client

pub fn describe_orderable_db_instance_options( &self ) -> DescribeOrderableDBInstanceOptionsFluentBuilder

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

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

    The name of the engine to retrieve instance options for.

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

    The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

    
    
  • db_instance_class(impl Into<String>) / set_db_instance_class(Option<String>):
    required: false
    

    The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

    
    
  • license_model(impl Into<String>) / set_license_model(Option<String>):
    required: false
    

    The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

    
    
  • vpc(bool) / set_vpc(Option<bool>):
    required: false
    

    The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

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

    
    
• On success, responds with DescribeOrderableDbInstanceOptionsOutput with field(s):
  • orderable_db_instance_options(Option<Vec::<OrderableDbInstanceOption>>):

    The options that are available for a particular orderable instance.

  • marker(Option<String>):

    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 failure, responds with SdkError<DescribeOrderableDBInstanceOptionsError>

impl Client

pub fn describe_pending_maintenance_actions( &self ) -> DescribePendingMaintenanceActionsFluentBuilder

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

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

    The ARN of a resource to return pending maintenance actions for.

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

    A filter that specifies one or more resources to return pending maintenance actions for.

    Supported filters:

    • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.

    • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

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

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

    
    
• On success, responds with DescribePendingMaintenanceActionsOutput with field(s):
  • pending_maintenance_actions(Option<Vec::<ResourcePendingMaintenanceActions>>):

    The maintenance actions to be applied.

  • marker(Option<String>):

    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 failure, responds with SdkError<DescribePendingMaintenanceActionsError>

impl Client

pub fn failover_db_cluster(&self) -> FailoverDBClusterFluentBuilder

Constructs a fluent builder for the FailoverDBCluster operation.

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

    A cluster identifier to force a failover for. This parameter is not case sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    
    
  • target_db_instance_identifier(impl Into<String>) / set_target_db_instance_identifier(Option<String>):
    required: false
    

    The name of the instance to promote to the primary instance.

    You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

    
    
• On success, responds with FailoverDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<FailoverDBClusterError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

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

    This parameter is not currently supported.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    A list of one or more tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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

    
    
• On success, responds with ModifyDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<ModifyDBClusterError>

impl Client

pub fn modify_db_cluster_parameter_group( &self ) -> ModifyDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ModifyDBClusterParameterGroup operation.

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

    The name of the cluster parameter group to modify.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: true
    

    A list of parameters in the cluster parameter group to modify.

    
    
• On success, responds with ModifyDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group_name(Option<String>):

    The name of a cluster parameter group.

    Constraints:

    • Must be from 1 to 255 letters or numbers.

    • The first character must be a letter.

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

    This value is stored as a lowercase string.

• On failure, responds with SdkError<ModifyDBClusterParameterGroupError>

impl Client

pub fn modify_db_cluster_snapshot_attribute( &self ) -> ModifyDBClusterSnapshotAttributeFluentBuilder

Constructs a fluent builder for the ModifyDBClusterSnapshotAttribute operation.

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

    The identifier for the cluster snapshot to modify the attributes for.

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The name of the cluster snapshot attribute to modify.

    To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

    
    
  • values_to_add(impl Into<String>) / set_values_to_add(Option<Vec::<String>>):
    required: false
    

    A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

    To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don’t want to be available to all Amazon Web Services accounts.

    
    
  • values_to_remove(impl Into<String>) / set_values_to_remove(Option<Vec::<String>>):
    required: false
    

    A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

    To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

    
    
• On success, responds with ModifyDbClusterSnapshotAttributeOutput with field(s):
  • db_cluster_snapshot_attributes_result(Option<DbClusterSnapshotAttributesResult>):

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

• On failure, responds with SdkError<ModifyDBClusterSnapshotAttributeError>

impl Client

pub fn modify_db_instance(&self) -> ModifyDBInstanceFluentBuilder

Constructs a fluent builder for the ModifyDBInstance operation.

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

    The instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    
    
  • db_instance_class(impl Into<String>) / set_db_instance_class(Option<String>):
    required: false
    

    The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

    If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

    Default: Uses existing setting.

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

    Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

    If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

    Default: false

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

    The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn’t result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

    Default: Uses existing setting.

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

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

    Constraints: Must be at least 30 minutes.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    
    
  • new_db_instance_identifier(impl Into<String>) / set_new_db_instance_identifier(Option<String>):
    required: false
    

    The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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: mydbinstance

    
    
  • ca_certificate_identifier(impl Into<String>) / set_ca_certificate_identifier(Option<String>):
    required: false
    

    Indicates the certificate that needs to be associated with the instance.

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    
    
  • promotion_tier(i32) / set_promotion_tier(Option<i32>):
    required: false
    

    A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid values: 0-15

    
    
  • enable_performance_insights(bool) / set_enable_performance_insights(Option<bool>):
    required: false
    

    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

    
    
  • performance_insights_kms_key_id(impl Into<String>) / set_performance_insights_kms_key_id(Option<String>):
    required: false
    

    The KMS key identifier for encryption of Performance Insights data.

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. 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.

    
    
  • certificate_rotation_restart(bool) / set_certificate_rotation_restart(Option<bool>):
    required: false
    

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

    
    
• On success, responds with ModifyDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Detailed information about an instance.

• On failure, responds with SdkError<ModifyDBInstanceError>

impl Client

pub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroupFluentBuilder

Constructs a fluent builder for the ModifyDBSubnetGroup operation.

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

    The name for the subnet group. This value is stored as a lowercase string. You can’t modify the default subnet group.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    
    
  • db_subnet_group_description(impl Into<String>) / set_db_subnet_group_description(Option<String>):
    required: false
    

    The description for the subnet group.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The Amazon EC2 subnet IDs for the subnet group.

    
    
• On success, responds with ModifyDbSubnetGroupOutput with field(s):
  • db_subnet_group(Option<DbSubnetGroup>):

    Detailed information about a subnet group.

• On failure, responds with SdkError<ModifyDBSubnetGroupError>

impl Client

pub fn modify_event_subscription(&self) -> ModifyEventSubscriptionFluentBuilder

Constructs a fluent builder for the ModifyEventSubscription operation.

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

    The name of the Amazon DocumentDB event notification subscription.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    
    
  • source_type(impl Into<String>) / set_source_type(Option<String>):
    required: false
    

    The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

    Valid values: db-instance, db-parameter-group, db-security-group

    
    
  • event_categories(impl Into<String>) / set_event_categories(Option<Vec::<String>>):
    required: false
    

    A list of event categories for a SourceType that you want to subscribe to.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    A Boolean value; set to true to activate the subscription.

    
    
• On success, responds with ModifyEventSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Detailed information about an event to which you have subscribed.

• On failure, responds with SdkError<ModifyEventSubscriptionError>

impl Client

pub fn modify_global_cluster(&self) -> ModifyGlobalClusterFluentBuilder

Constructs a fluent builder for the ModifyGlobalCluster operation.

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

    The identifier for the global cluster being modified. This parameter isn’t case-sensitive.

    Constraints:

    • Must match the identifier of an existing global cluster.

    
    
  • new_global_cluster_identifier(impl Into<String>) / set_new_global_cluster_identifier(Option<String>):
    required: false
    

    The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

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

      The first character must be a letter

      Can’t end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

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

    Indicates if the global cluster has deletion protection enabled. The global cluster can’t be deleted when deletion protection is enabled.

    
    
• On success, responds with ModifyGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    A data type representing an Amazon DocumentDB global cluster.

• On failure, responds with SdkError<ModifyGlobalClusterError>

impl Client

pub fn reboot_db_instance(&self) -> RebootDBInstanceFluentBuilder

Constructs a fluent builder for the RebootDBInstance operation.

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

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    
    
  • force_failover(bool) / set_force_failover(Option<bool>):
    required: false
    

    When true, the reboot is conducted through a Multi-AZ failover.

    Constraint: You can’t specify true if the instance is not configured for Multi-AZ.

    
    
• On success, responds with RebootDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Detailed information about an instance.

• On failure, responds with SdkError<RebootDBInstanceError>

impl Client

pub fn remove_from_global_cluster(&self) -> RemoveFromGlobalClusterFluentBuilder

Constructs a fluent builder for the RemoveFromGlobalCluster operation.

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

    The cluster identifier to detach from the Amazon DocumentDB global cluster.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

    
    
• On success, responds with RemoveFromGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    A data type representing an Amazon DocumentDB global cluster.

• On failure, responds with SdkError<RemoveFromGlobalClusterError>

impl Client

pub fn remove_source_identifier_from_subscription( &self ) -> RemoveSourceIdentifierFromSubscriptionFluentBuilder

Constructs a fluent builder for the RemoveSourceIdentifierFromSubscription operation.

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

    The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

    
    
  • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):
    required: true
    

    The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

    
    
• On success, responds with RemoveSourceIdentifierFromSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Detailed information about an event to which you have subscribed.

• On failure, responds with SdkError<RemoveSourceIdentifierFromSubscriptionError>

impl Client

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

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

    The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag key (name) of the tag to be removed.

    
    
• On success, responds with RemoveTagsFromResourceOutput
• On failure, responds with SdkError<RemoveTagsFromResourceError>

impl Client

pub fn reset_db_cluster_parameter_group( &self ) -> ResetDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ResetDBClusterParameterGroup operation.

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

    The name of the cluster parameter group to reset.

    
    
  • reset_all_parameters(bool) / set_reset_all_parameters(Option<bool>):
    required: false
    

    A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can’t use this parameter if there is a list of parameter names specified for the Parameters parameter.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    A list of parameter names in the cluster parameter group to reset to the default values. You can’t use this parameter if the ResetAllParameters parameter is set to true.

    
    
• On success, responds with ResetDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group_name(Option<String>):

    The name of a cluster parameter group.

    Constraints:

    • Must be from 1 to 255 letters or numbers.

    • The first character must be a letter.

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

    This value is stored as a lowercase string.

• On failure, responds with SdkError<ResetDBClusterParameterGroupError>

impl Client

pub fn restore_db_cluster_from_snapshot( &self ) -> RestoreDBClusterFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreDBClusterFromSnapshot operation.

• The fluent builder is configurable:
  • availability_zones(impl Into<String>) / set_availability_zones(Option<Vec::<String>>):
    required: false
    

    Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn’t 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-snapshot-id

    
    
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    The identifier for the snapshot or cluster snapshot to restore from.

    You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

    Constraints:

    • Must match the identifier of an existing snapshot.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The database engine to use for the new cluster.

    Default: The same as source.

    Constraint: Must be compatible with the engine of the source.

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

    The version of the database engine to use for the new cluster.

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

    The port number on which the new cluster accepts connections.

    Constraints: Must be a value from 1150 to 65535.

    Default: The same port as the original cluster.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    The name of the subnet group to use for the new cluster.

    Constraints: If provided, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

    
    
  • 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 new cluster will belong to.

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

    The tags to be assigned to the restored cluster.

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

    The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If you do not specify a value for the KmsKeyId parameter, then the following occurs:

    • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

    • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

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

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

    The name of the DB cluster parameter group to associate with this DB cluster.

    Type: String.       Required: No.

    If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • 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

    
    
• On success, responds with RestoreDbClusterFromSnapshotOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<RestoreDBClusterFromSnapshotError>

impl Client

pub fn restore_db_cluster_to_point_in_time( &self ) -> RestoreDBClusterToPointInTimeFluentBuilder

Constructs a fluent builder for the RestoreDBClusterToPointInTime operation.

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

    The name of the new cluster to be created.

    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.

    
    
  • restore_type(impl Into<String>) / set_restore_type(Option<String>):
    required: false
    

    The type of restore to be performed. You can specify one of the following values:

    • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

    • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

    Constraints: You can’t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    If you don’t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

    
    
  • source_db_cluster_identifier(impl Into<String>) / set_source_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the source cluster from which to restore.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    
    
  • restore_to_time(DateTime) / set_restore_to_time(Option<DateTime>):
    required: false
    

    The date and time to restore the cluster to.

    Valid values: A time in Universal Coordinated Time (UTC) format.

    Constraints:

    • Must be before the latest restorable time for the instance.

    • Must be specified if the UseLatestRestorableTime parameter is not provided.

    • Cannot be specified if the UseLatestRestorableTime parameter is true.

    • Cannot be specified if the RestoreType parameter is copy-on-write.

    Example: 2015-03-07T23:45:00Z

    
    
  • use_latest_restorable_time(bool) / set_use_latest_restorable_time(Option<bool>):
    required: false
    

    A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

    Default: false

    Constraints: Cannot be specified if the RestoreToTime parameter is provided.

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

    The port number on which the new cluster accepts connections.

    Constraints: Must be a value from 1150 to 65535.

    Default: The default port for the engine.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    The subnet group name to use for the new cluster.

    Constraints: If provided, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

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

    A list of VPC security groups that the new cluster belongs to.

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

    The tags to be assigned to the restored cluster.

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

    The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

    If you do not specify a value for the KmsKeyId parameter, then the following occurs:

    • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

    • If the cluster is not encrypted, then the restored cluster is not encrypted.

    If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    
    
  • 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

    
    
• On success, responds with RestoreDbClusterToPointInTimeOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<RestoreDBClusterToPointInTimeError>

impl Client

pub fn start_db_cluster(&self) -> StartDBClusterFluentBuilder

Constructs a fluent builder for the StartDBCluster operation.

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

    The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

    
    
• On success, responds with StartDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<StartDBClusterError>

impl Client

pub fn stop_db_cluster(&self) -> StopDBClusterFluentBuilder

Constructs a fluent builder for the StopDBCluster operation.

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

    The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

    
    
• On success, responds with StopDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Detailed information about a cluster.

• On failure, responds with SdkError<StopDBClusterError>

impl Client

pub fn switchover_global_cluster(&self) -> SwitchoverGlobalClusterFluentBuilder

Constructs a fluent builder for the SwitchoverGlobalCluster operation.

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

    The identifier of the Amazon DocumentDB global database cluster to switch over. The identifier is the unique key assigned by the user when the cluster is created. In other words, it’s the name of the global cluster. This parameter isn’t case-sensitive.

    Constraints:

    • Must match the identifier of an existing global cluster (Amazon DocumentDB global database).

    • Minimum length of 1. Maximum length of 255.

    Pattern: [A-Za-z][0-9A-Za-z-:._]*

    
    
  • target_db_cluster_identifier(impl Into<String>) / set_target_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the secondary Amazon DocumentDB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

    Constraints:

    • Must match the identifier of an existing secondary cluster.

    • Minimum length of 1. Maximum length of 255.

    Pattern: [A-Za-z][0-9A-Za-z-:._]*

    
    
• On success, responds with SwitchoverGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    A data type representing an Amazon DocumentDB global cluster.

• On failure, responds with SdkError<SwitchoverGlobalClusterError>

impl Client

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.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.