Struct aws_sdk_docdb::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon DocumentDB with MongoDB compatibility
Client for invoking operations on Amazon DocumentDB with MongoDB compatibility. Each operation on Amazon DocumentDB with MongoDB compatibility is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_docdb::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_docdb::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_docdb::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn add_source_identifier_to_subscription(
&self
) -> AddSourceIdentifierToSubscription
pub fn add_source_identifier_to_subscription(
&self
) -> AddSourceIdentifierToSubscription
Constructs a fluent builder for the AddSourceIdentifierToSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
: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>)
: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>
Constructs a fluent builder for the AddTagsToResource
operation.
- The fluent builder is configurable:
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the Amazon DocumentDB resource.
- On success, responds with
AddTagsToResourceOutput
- On failure, responds with
SdkError<AddTagsToResourceError>
sourcepub fn apply_pending_maintenance_action(&self) -> ApplyPendingMaintenanceAction
pub fn apply_pending_maintenance_action(&self) -> ApplyPendingMaintenanceAction
Constructs a fluent builder for the ApplyPendingMaintenanceAction
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
: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>)
: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>)
: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 existingnext-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>
sourcepub fn copy_db_cluster_parameter_group(&self) -> CopyDBClusterParameterGroup
pub fn copy_db_cluster_parameter_group(&self) -> CopyDBClusterParameterGroup
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>)
: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 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 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>)
: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>)
:A description for the copied cluster parameter group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshot
pub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshot
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>)
: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 Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different 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>)
: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>)
: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 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 forKmsKeyId
, 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 account, then you must specify a value for
KmsKeyId
.To copy an encrypted cluster snapshot to another 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 Region that they are created in, and you can’t use encryption keys from one Region in another 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>)
:The URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot
API action in the Region that contains the source cluster snapshot to copy. You must use thePreSignedUrl
parameter when copying a cluster snapshot from another 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 specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.The presigned URL must be a valid request for the
CopyDBClusterSnapshot
API action that can be executed in the source 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 Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then yourSourceDBClusterSnapshotIdentifier
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>)
:Set to
true
to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwisefalse
. The default isfalse
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_db_cluster(&self) -> CreateDBCluster
pub fn create_db_cluster(&self) -> CreateDBCluster
Constructs a fluent builder for the CreateDBCluster
operation.
- The fluent builder is configurable:
availability_zones(Vec<String>)
/set_availability_zones(Option<Vec<String>>)
: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>)
: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>)
: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>)
:The name of the cluster parameter group to associate with this cluster.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
: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>)
: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>)
: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>)
: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>)
:The port number on which the instances in the cluster accept connections.
master_username(impl Into<String>)
/set_master_username(Option<String>)
: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>)
: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>)
: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 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>)
: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 Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the cluster.
storage_encrypted(bool)
/set_storage_encrypted(Option<bool>)
:Specifies whether the cluster is encrypted.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
: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 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 istrue
, Amazon DocumentDB uses your default encryption key.
KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.
-
pre_signed_url(impl Into<String>)
/set_pre_signed_url(Option<String>)
:Not currently supported.
enable_cloudwatch_logs_exports(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
: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>)
:Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.global_cluster_identifier(impl Into<String>)
/set_global_cluster_identifier(Option<String>)
:The cluster identifier of the new global cluster.
- On success, responds with
CreateDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Detailed information about a cluster.
- On failure, responds with
SdkError<CreateDBClusterError>
sourcepub fn create_db_cluster_parameter_group(&self) -> CreateDBClusterParameterGroup
pub fn create_db_cluster_parameter_group(&self) -> CreateDBClusterParameterGroup
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>)
: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>)
:The cluster parameter group family name.
description(impl Into<String>)
/set_description(Option<String>)
:The description for the cluster parameter group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshot
pub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshot
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>)
: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>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_db_instance(&self) -> CreateDBInstance
pub fn create_db_instance(&self) -> CreateDBInstance
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>)
: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>)
:The compute and memory capacity of the instance; for example,
db.r5.large
.engine(impl Into<String>)
/set_engine(Option<String>)
: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>)
:The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint’s Region.
Example:
us-east-1d
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
: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 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>)
:This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default:
false
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>)
:The identifier of the cluster that the instance will belong to.
promotion_tier(i32)
/set_promotion_tier(Option<i32>)
: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
- On success, responds with
CreateDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Detailed information about an instance.
- On failure, responds with
SdkError<CreateDBInstanceError>
sourcepub fn create_db_subnet_group(&self) -> CreateDBSubnetGroup
pub fn create_db_subnet_group(&self) -> CreateDBSubnetGroup
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>)
: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>)
:The description for the subnet group.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:The Amazon EC2 subnet IDs for the subnet group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_event_subscription(&self) -> CreateEventSubscription
pub fn create_event_subscription(&self) -> CreateEventSubscription
Constructs a fluent builder for the CreateEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
: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>)
: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>)
: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(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for a
SourceType
that you want to subscribe to.source_ids(Vec<String>)
/set_source_ids(Option<Vec<String>>)
: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>)
:A Boolean value; set to
true
to activate the subscription, set tofalse
to create the subscription but not active it.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_global_cluster(&self) -> CreateGlobalCluster
pub fn create_global_cluster(&self) -> CreateGlobalCluster
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>)
:The cluster identifier of the new global cluster.
source_db_cluster_identifier(impl Into<String>)
/set_source_db_cluster_identifier(Option<String>)
: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>)
:The name of the database engine to be used for this cluster.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The engine version of the global cluster.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
: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>)
: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>)
: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>
sourcepub fn delete_db_cluster(&self) -> DeleteDBCluster
pub fn delete_db_cluster(&self) -> DeleteDBCluster
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>)
: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(bool)
:Determines whether a final cluster snapshot is created before the cluster is deleted. If
true
is specified, no cluster snapshot is created. Iffalse
is specified, a cluster snapshot is created before the DB cluster is deleted.If
SkipFinalSnapshot
isfalse
, you must specify aFinalDBSnapshotIdentifier
parameter.Default:
false
final_db_snapshot_identifier(impl Into<String>)
/set_final_db_snapshot_identifier(Option<String>)
:The cluster snapshot identifier of the new cluster snapshot created when
SkipFinalSnapshot
is set tofalse
.Specifying this parameter and also setting the
SkipFinalShapshot
parameter totrue
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>
sourcepub fn delete_db_cluster_parameter_group(&self) -> DeleteDBClusterParameterGroup
pub fn delete_db_cluster_parameter_group(&self) -> DeleteDBClusterParameterGroup
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>)
: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>
sourcepub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshot
pub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshot
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>)
: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>
sourcepub fn delete_db_instance(&self) -> DeleteDBInstance
pub fn delete_db_instance(&self) -> DeleteDBInstance
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>)
: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>
sourcepub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroup
pub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroup
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>)
: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>
sourcepub fn delete_event_subscription(&self) -> DeleteEventSubscription
pub fn delete_event_subscription(&self) -> DeleteEventSubscription
Constructs a fluent builder for the DeleteEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
: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>
sourcepub fn delete_global_cluster(&self) -> DeleteGlobalCluster
pub fn delete_global_cluster(&self) -> DeleteGlobalCluster
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>)
: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>
sourcepub fn describe_certificates(&self) -> DescribeCertificates
pub fn describe_certificates(&self) -> DescribeCertificates
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>)
: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(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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 byMaxRecords
.
- On success, responds with
DescribeCertificatesOutput
with field(s):certificates(Option<Vec<Certificate>>)
:A list of certificates for this 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 ofMarker
in the next call toDescribeCertificates
results in the next page of certificates.
- On failure, responds with
SdkError<DescribeCertificatesError>
sourcepub fn describe_db_cluster_parameter_groups(
&self
) -> DescribeDBClusterParameterGroups
pub fn describe_db_cluster_parameter_groups(
&self
) -> DescribeDBClusterParameterGroups
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>)
:The name of a specific cluster parameter group to return details for.
Constraints:
-
If provided, must match the name of an existing
DBClusterParameterGroup
.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_db_cluster_parameters(&self) -> DescribeDBClusterParameters
pub fn describe_db_cluster_parameters(&self) -> DescribeDBClusterParameters
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>)
: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>)
:A value that indicates to return only parameters for a specific source. Parameter sources can be
engine
,service
, orcustomer
.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_db_clusters(&self) -> DescribeDBClusters
pub fn describe_db_clusters(&self) -> DescribeDBClusters
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>)
: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(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
: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>)
: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>)
: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>
sourcepub fn describe_db_cluster_snapshot_attributes(
&self
) -> DescribeDBClusterSnapshotAttributes
pub fn describe_db_cluster_snapshot_attributes(
&self
) -> DescribeDBClusterSnapshotAttributes
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>)
: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>
sourcepub fn describe_db_cluster_snapshots(&self) -> DescribeDBClusterSnapshots
pub fn describe_db_cluster_snapshots(&self) -> DescribeDBClusterSnapshots
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>)
: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>)
: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>)
: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 account. -
manual
- Return all cluster snapshots that you have manually created for your account. -
shared
- Return all manual cluster snapshots that have been shared to your 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 theIncludeShared
parameter totrue
. You can include public cluster snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters don’t apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn’t apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn’t apply whenSnapshotType
is set topublic
.-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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(bool)
:Set to
true
to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwisefalse
. The default isfalse
.include_public(bool)
/set_include_public(bool)
:Set to
true
to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwisefalse
. The default isfalse
.
- 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>
sourcepub fn describe_db_engine_versions(&self) -> DescribeDBEngineVersions
pub fn describe_db_engine_versions(&self) -> DescribeDBEngineVersions
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>)
:The database engine to return.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The database engine version to return.
Example:
3.6.0
db_parameter_group_family(impl Into<String>)
/set_db_parameter_group_family(Option<String>)
:The name of a specific parameter group family to return details for.
Constraints:
-
If provided, must match an existing
DBParameterGroupFamily
.
-
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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(bool)
: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>)
:If this parameter is specified and the requested engine supports the
CharacterSetName
parameter forCreateDBInstance
, the response includes a list of supported character sets for each engine version.list_supported_timezones(bool)
/set_list_supported_timezones(Option<bool>)
:If this parameter is specified and the requested engine supports the
TimeZone
parameter forCreateDBInstance
, 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>
sourcepub fn describe_db_instances(&self) -> DescribeDBInstances
pub fn describe_db_instances(&self) -> DescribeDBInstances
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>)
: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(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
: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>)
: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>)
: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>
sourcepub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroups
pub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroups
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>)
:The name of the subnet group to return details for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_engine_default_cluster_parameters(
&self
) -> DescribeEngineDefaultClusterParameters
pub fn describe_engine_default_cluster_parameters(
&self
) -> DescribeEngineDefaultClusterParameters
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>)
:The name of the cluster parameter group family to return the engine parameter information for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_event_categories(&self) -> DescribeEventCategories
pub fn describe_event_categories(&self) -> DescribeEventCategories
Constructs a fluent builder for the DescribeEventCategories
operation.
- The fluent builder is configurable:
source_type(impl Into<String>)
/set_source_type(Option<String>)
:The type of source that is generating the events.
Valid values:
db-instance
,db-parameter-group
,db-security-group
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
: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>
sourcepub fn describe_events(&self) -> DescribeEvents
pub fn describe_events(&self) -> DescribeEvents
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>)
: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
, aDBInstanceIdentifier
must be provided. -
If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be provided. -
If the source type is
DBParameterGroup
, aDBParameterGroupName
must be provided. -
If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be provided. -
Cannot end with a hyphen or contain two consecutive hyphens.
-
source_type(SourceType)
/set_source_type(Option<SourceType>)
:The event source to retrieve events for. If no value is specified, all events are returned.
start_time(DateTime)
/set_start_time(Option<DateTime>)
: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>)
: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>)
:The number of minutes to retrieve events for.
Default: 60
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories that trigger notifications for an event notification subscription.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_event_subscriptions(&self) -> DescribeEventSubscriptions
pub fn describe_event_subscriptions(&self) -> DescribeEventSubscriptions
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>)
:The name of the Amazon DocumentDB event notification subscription that you want to describe.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_global_clusters(&self) -> DescribeGlobalClusters
pub fn describe_global_clusters(&self) -> DescribeGlobalClusters
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>)
: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(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
: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>)
: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>)
: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 byMaxRecords
.
- On success, responds with
DescribeGlobalClustersOutput
with field(s): - On failure, responds with
SdkError<DescribeGlobalClustersError>
sourcepub fn describe_orderable_db_instance_options(
&self
) -> DescribeOrderableDBInstanceOptions
pub fn describe_orderable_db_instance_options(
&self
) -> DescribeOrderableDBInstanceOptions
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>)
:The name of the engine to retrieve instance options for.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
: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>)
: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>)
: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>)
:The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:This parameter is not currently supported.
max_records(i32)
/set_max_records(Option<i32>)
: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>)
: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>
sourcepub fn describe_pending_maintenance_actions(
&self
) -> DescribePendingMaintenanceActions
pub fn describe_pending_maintenance_actions(
&self
) -> DescribePendingMaintenanceActions
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>)
:The ARN of a resource to return pending maintenance actions for.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
: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>)
: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>)
: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>
sourcepub fn failover_db_cluster(&self) -> FailoverDBCluster
pub fn failover_db_cluster(&self) -> FailoverDBCluster
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>)
: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>)
: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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
: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>
sourcepub fn modify_db_cluster(&self) -> ModifyDBCluster
pub fn modify_db_cluster(&self) -> ModifyDBCluster
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>)
: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>)
: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(bool)
: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 tofalse
, changes to the cluster are applied during the next maintenance window.The
ApplyImmediately
parameter affects only theNewDBClusterIdentifier
andMasterUserPassword
values. If you set this parameter value tofalse
, the changes to theNewDBClusterIdentifier
andMasterUserPassword
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.Default:
false
backup_retention_period(i32)
/set_backup_retention_period(Option<i32>)
: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>)
:The name of the cluster parameter group to use for the cluster.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of virtual private cloud (VPC) security groups that the cluster will belong to.
port(i32)
/set_port(Option<i32>)
:The port number on which the cluster accepts connections.
Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
master_user_password(impl Into<String>)
/set_master_user_password(Option<String>)
: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>)
: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 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>)
: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 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>)
:The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The
EnableLogTypes
andDisableLogTypes
arrays determine which logs are exported (or not exported) to CloudWatch Logs.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.
- On success, responds with
ModifyDbClusterOutput
with field(s):db_cluster(Option<DbCluster>)
:Detailed information about a cluster.
- On failure, responds with
SdkError<ModifyDBClusterError>
sourcepub fn modify_db_cluster_parameter_group(&self) -> ModifyDBClusterParameterGroup
pub fn modify_db_cluster_parameter_group(&self) -> ModifyDBClusterParameterGroup
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>)
:The name of the cluster parameter group to modify.
parameters(Vec<Parameter>)
/set_parameters(Option<Vec<Parameter>>)
: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>
sourcepub fn modify_db_cluster_snapshot_attribute(
&self
) -> ModifyDBClusterSnapshotAttribute
pub fn modify_db_cluster_snapshot_attribute(
&self
) -> ModifyDBClusterSnapshotAttribute
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>)
:The identifier for the cluster snapshot to modify the attributes for.
attribute_name(impl Into<String>)
/set_attribute_name(Option<String>)
:The name of the cluster snapshot attribute to modify.
To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to
restore
.values_to_add(Vec<String>)
/set_values_to_add(Option<Vec<String>>)
:A list of cluster snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to
all
. Do not add theall
value for any manual cluster snapshots that contain private information that you don’t want to be available to all accounts.values_to_remove(Vec<String>)
/set_values_to_remove(Option<Vec<String>>)
:A list of cluster snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to
all
. If you specifyall
, an account whose account ID is explicitly added to therestore
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>
sourcepub fn modify_db_instance(&self) -> ModifyDBInstance
pub fn modify_db_instance(&self) -> ModifyDBInstance
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>)
: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>)
:The new compute and memory capacity of the instance; for example,
db.r5.large
. Not all instance classes are available in all 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 astrue
for this request.Default: Uses existing setting.
apply_immediately(bool)
/set_apply_immediately(bool)
: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>)
: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>)
: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>)
: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
totrue
. It occurs during the next maintenance window if you setApply Immediately
tofalse
. 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>)
:Indicates the certificate that needs to be associated with the instance.
promotion_tier(i32)
/set_promotion_tier(Option<i32>)
: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
- On success, responds with
ModifyDbInstanceOutput
with field(s):db_instance(Option<DbInstance>)
:Detailed information about an instance.
- On failure, responds with
SdkError<ModifyDBInstanceError>
sourcepub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroup
pub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroup
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>)
: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>)
:The description for the subnet group.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
: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>
sourcepub fn modify_event_subscription(&self) -> ModifyEventSubscription
pub fn modify_event_subscription(&self) -> ModifyEventSubscription
Constructs a fluent builder for the ModifyEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the Amazon DocumentDB event notification subscription.
sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
: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>)
: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(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for a
SourceType
that you want to subscribe to.enabled(bool)
/set_enabled(Option<bool>)
: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>
sourcepub fn modify_global_cluster(&self) -> ModifyGlobalCluster
pub fn modify_global_cluster(&self) -> ModifyGlobalCluster
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>)
: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>)
: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>)
: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>
sourcepub fn reboot_db_instance(&self) -> RebootDBInstance
pub fn reboot_db_instance(&self) -> RebootDBInstance
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>)
: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>)
: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>
sourcepub fn remove_from_global_cluster(&self) -> RemoveFromGlobalCluster
pub fn remove_from_global_cluster(&self) -> RemoveFromGlobalCluster
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>)
:The cluster identifier to detach from the Amazon DocumentDB global cluster.
db_cluster_identifier(impl Into<String>)
/set_db_cluster_identifier(Option<String>)
: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>
sourcepub fn remove_source_identifier_from_subscription(
&self
) -> RemoveSourceIdentifierFromSubscription
pub fn remove_source_identifier_from_subscription(
&self
) -> RemoveSourceIdentifierFromSubscription
Constructs a fluent builder for the RemoveSourceIdentifierFromSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
: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>)
: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>
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag key (name) of the tag to be removed.
- On success, responds with
RemoveTagsFromResourceOutput
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
sourcepub fn reset_db_cluster_parameter_group(&self) -> ResetDBClusterParameterGroup
pub fn reset_db_cluster_parameter_group(&self) -> ResetDBClusterParameterGroup
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>)
:The name of the cluster parameter group to reset.
reset_all_parameters(bool)
/set_reset_all_parameters(bool)
:A value that is set to
true
to reset all parameters in the cluster parameter group to their default values, andfalse
otherwise. You can’t use this parameter if there is a list of parameter names specified for theParameters
parameter.parameters(Vec<Parameter>)
/set_parameters(Option<Vec<Parameter>>)
: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 totrue
.
- 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>
sourcepub fn restore_db_cluster_from_snapshot(&self) -> RestoreDBClusterFromSnapshot
pub fn restore_db_cluster_from_snapshot(&self) -> RestoreDBClusterFromSnapshot
Constructs a fluent builder for the RestoreDBClusterFromSnapshot
operation.
- The fluent builder is configurable:
availability_zones(Vec<String>)
/set_availability_zones(Option<Vec<String>>)
: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>)
: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>)
: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>)
: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>)
:The version of the database engine to use for the new cluster.
port(i32)
/set_port(Option<i32>)
:The port number on which the new cluster accepts connections.
Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
: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(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the restored cluster.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
: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 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(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.
- On success, responds with
RestoreDbClusterFromSnapshotOutput
with field(s):db_cluster(Option<DbCluster>)
:Detailed information about a cluster.
- On failure, responds with
SdkError<RestoreDBClusterFromSnapshotError>
sourcepub fn restore_db_cluster_to_point_in_time(
&self
) -> RestoreDBClusterToPointInTime
pub fn restore_db_cluster_to_point_in_time(
&self
) -> RestoreDBClusterToPointInTime
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>)
: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.
-
source_db_cluster_identifier(impl Into<String>)
/set_source_db_cluster_identifier(Option<String>)
: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>)
: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 istrue
. -
Cannot be specified if the
RestoreType
parameter iscopy-on-write
.
Example:
2015-03-07T23:45:00Z
-
use_latest_restorable_time(bool)
/set_use_latest_restorable_time(bool)
:A value that is set to
true
to restore the cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if the
RestoreToTime
parameter is provided.port(i32)
/set_port(Option<i32>)
:The port number on which the new cluster accepts connections.
Constraints: Must be a value from
1150
to65535
.Default: The default port for the engine.
db_subnet_group_name(impl Into<String>)
/set_db_subnet_group_name(Option<String>)
: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(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:A list of VPC security groups that the new cluster belongs to.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the restored cluster.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
: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 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(Vec<String>)
/set_enable_cloudwatch_logs_exports(Option<Vec<String>>)
:A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
deletion_protection(bool)
/set_deletion_protection(Option<bool>)
:Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.
- On success, responds with
RestoreDbClusterToPointInTimeOutput
with field(s):db_cluster(Option<DbCluster>)
:Detailed information about a cluster.
- On failure, responds with
SdkError<RestoreDBClusterToPointInTimeError>
sourcepub fn start_db_cluster(&self) -> StartDBCluster
pub fn start_db_cluster(&self) -> StartDBCluster
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>)
: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>
sourcepub fn stop_db_cluster(&self) -> StopDBCluster
pub fn stop_db_cluster(&self) -> StopDBCluster
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>)
: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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more