1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
pub(crate) conf: crate::Config,
#[allow(dead_code)] // unused when a service does not provide any operations
pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
}
/// Client for Amazon Relational Database Service
///
/// Client for invoking operations on Amazon Relational Database Service. Each operation on Amazon Relational Database Service is a method on this
/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
/// ## Constructing a `Client`
///
/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
/// crate should be used to automatically resolve this config using
/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
/// across multiple different AWS SDK clients. This config resolution process can be customized
/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
/// the [builder pattern] to customize the default config.
///
/// In the simplest case, creating a client looks as follows:
/// ```rust,no_run
/// # async fn wrapper() {
/// let config = aws_config::load_from_env().await;
/// let client = aws_sdk_rds::Client::new(&config);
/// # }
/// ```
///
/// Occasionally, SDKs may have additional service-specific that can be set on the [`Config`] that
/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
/// The [`Config`] struct implements `From<&SdkConfig>`, so setting these specific settings can be
/// done as follows:
///
/// ```rust,no_run
/// # async fn wrapper() {
/// let sdk_config = ::aws_config::load_from_env().await;
/// let config = aws_sdk_rds::config::Builder::from(&sdk_config)
/// # /*
/// .some_service_specific_setting("value")
/// # */
/// .build();
/// # }
/// ```
///
/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
///
/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
/// be done once at application start-up.
///
/// [`Config`]: crate::Config
/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
/// [`aws-config` docs]: https://docs.rs/aws-config/*
/// [`aws-config`]: https://crates.io/crates/aws-config
/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
/// # Using the `Client`
///
/// A client has a function for every operation that can be performed by the service.
/// For example, the [`AddRoleToDBCluster`](crate::operation::add_role_to_db_cluster) operation has
/// a [`Client::add_role_to_db_cluster`], function which returns a builder for that operation.
/// The fluent builder ultimately has a `send()` function that returns an async future that
/// returns a result, as illustrated below:
///
/// ```rust,ignore
/// let result = client.add_role_to_db_cluster()
/// .db_cluster_identifier("example")
/// .send()
/// .await;
/// ```
///
/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
/// information.
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct Client {
handle: ::std::sync::Arc<Handle>,
}
impl Client {
/// Creates a new client from the service [`Config`](crate::Config).
///
/// # Panics
///
/// This method will panic in the following cases:
///
/// - Retries or timeouts are enabled without a `sleep_impl` configured.
/// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
/// - No `behavior_version` is provided.
///
/// The panic message for each of these will have instructions on how to resolve them.
#[track_caller]
pub fn from_conf(conf: crate::Config) -> Self {
let handle = Handle {
conf: conf.clone(),
runtime_plugins: crate::config::base_client_runtime_plugins(conf),
};
if let Err(err) = Self::validate_config(&handle) {
panic!("Invalid client configuration: {err}");
}
Self {
handle: ::std::sync::Arc::new(handle),
}
}
/// Returns the client's configuration.
pub fn config(&self) -> &crate::Config {
&self.handle.conf
}
fn validate_config(handle: &Handle) -> Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
handle
.runtime_plugins
.apply_client_configuration(&mut cfg)?
.validate_base_client_config(&cfg)?;
Ok(())
}
}
impl Client {
/// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
///
/// # Panics
///
/// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
/// - This method will panic if no `BehaviorVersion` is provided. If you experience this panic, set `behavior_version` on the Config or enable the `behavior-version-latest` Cargo feature.
#[track_caller]
pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
Self::from_conf(sdk_config.into())
}
}
mod add_role_to_db_cluster;
mod add_role_to_db_instance;
mod add_source_identifier_to_subscription;
mod add_tags_to_resource;
mod apply_pending_maintenance_action;
mod authorize_db_security_group_ingress;
mod backtrack_db_cluster;
mod cancel_export_task;
mod copy_db_cluster_parameter_group;
mod copy_db_cluster_snapshot;
mod copy_db_parameter_group;
mod copy_db_snapshot;
mod copy_option_group;
mod create_blue_green_deployment;
mod create_custom_db_engine_version;
mod create_db_cluster;
mod create_db_cluster_endpoint;
mod create_db_cluster_parameter_group;
mod create_db_cluster_snapshot;
mod create_db_instance;
mod create_db_instance_read_replica;
mod create_db_parameter_group;
mod create_db_proxy;
mod create_db_proxy_endpoint;
mod create_db_security_group;
mod create_db_snapshot;
mod create_db_subnet_group;
mod create_event_subscription;
mod create_global_cluster;
mod create_integration;
mod create_option_group;
mod create_tenant_database;
/// Operation customization and supporting types.
///
/// The underlying HTTP requests made during an operation can be customized
/// by calling the `customize()` method on the builder returned from a client
/// operation call. For example, this can be used to add an additional HTTP header:
///
/// ```ignore
/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_rds::Error> {
/// # let client: aws_sdk_rds::Client = unimplemented!();
/// use ::http::header::{HeaderName, HeaderValue};
///
/// let result = client.add_role_to_db_cluster()
/// .customize()
/// .mutate_request(|req| {
/// // Add `x-example-header` with value
/// req.headers_mut()
/// .insert(
/// HeaderName::from_static("x-example-header"),
/// HeaderValue::from_static("1"),
/// );
/// })
/// .send()
/// .await;
/// # }
/// ```
pub mod customize;
mod delete_blue_green_deployment;
mod delete_custom_db_engine_version;
mod delete_db_cluster;
mod delete_db_cluster_automated_backup;
mod delete_db_cluster_endpoint;
mod delete_db_cluster_parameter_group;
mod delete_db_cluster_snapshot;
mod delete_db_instance;
mod delete_db_instance_automated_backup;
mod delete_db_parameter_group;
mod delete_db_proxy;
mod delete_db_proxy_endpoint;
mod delete_db_security_group;
mod delete_db_snapshot;
mod delete_db_subnet_group;
mod delete_event_subscription;
mod delete_global_cluster;
mod delete_integration;
mod delete_option_group;
mod delete_tenant_database;
mod deregister_db_proxy_targets;
mod describe_account_attributes;
mod describe_blue_green_deployments;
mod describe_certificates;
mod describe_db_cluster_automated_backups;
mod describe_db_cluster_backtracks;
mod describe_db_cluster_endpoints;
mod describe_db_cluster_parameter_groups;
mod describe_db_cluster_parameters;
mod describe_db_cluster_snapshot_attributes;
mod describe_db_cluster_snapshots;
mod describe_db_clusters;
mod describe_db_engine_versions;
mod describe_db_instance_automated_backups;
mod describe_db_instances;
mod describe_db_log_files;
mod describe_db_parameter_groups;
mod describe_db_parameters;
mod describe_db_proxies;
mod describe_db_proxy_endpoints;
mod describe_db_proxy_target_groups;
mod describe_db_proxy_targets;
mod describe_db_security_groups;
mod describe_db_snapshot_attributes;
mod describe_db_snapshot_tenant_databases;
mod describe_db_snapshots;
mod describe_db_subnet_groups;
mod describe_engine_default_cluster_parameters;
mod describe_engine_default_parameters;
mod describe_event_categories;
mod describe_event_subscriptions;
mod describe_events;
mod describe_export_tasks;
mod describe_global_clusters;
mod describe_integrations;
mod describe_option_group_options;
mod describe_option_groups;
mod describe_orderable_db_instance_options;
mod describe_pending_maintenance_actions;
mod describe_reserved_db_instances;
mod describe_reserved_db_instances_offerings;
mod describe_source_regions;
mod describe_tenant_databases;
mod describe_valid_db_instance_modifications;
mod download_db_log_file_portion;
mod failover_db_cluster;
mod failover_global_cluster;
mod list_tags_for_resource;
mod modify_activity_stream;
mod modify_certificates;
mod modify_current_db_cluster_capacity;
mod modify_custom_db_engine_version;
mod modify_db_cluster;
mod modify_db_cluster_endpoint;
mod modify_db_cluster_parameter_group;
mod modify_db_cluster_snapshot_attribute;
mod modify_db_instance;
mod modify_db_parameter_group;
mod modify_db_proxy;
mod modify_db_proxy_endpoint;
mod modify_db_proxy_target_group;
mod modify_db_snapshot;
mod modify_db_snapshot_attribute;
mod modify_db_subnet_group;
mod modify_event_subscription;
mod modify_global_cluster;
mod modify_option_group;
mod modify_tenant_database;
mod promote_read_replica;
mod promote_read_replica_db_cluster;
mod purchase_reserved_db_instances_offering;
mod reboot_db_cluster;
mod reboot_db_instance;
mod register_db_proxy_targets;
mod remove_from_global_cluster;
mod remove_role_from_db_cluster;
mod remove_role_from_db_instance;
mod remove_source_identifier_from_subscription;
mod remove_tags_from_resource;
mod reset_db_cluster_parameter_group;
mod reset_db_parameter_group;
mod restore_db_cluster_from_s3;
mod restore_db_cluster_from_snapshot;
mod restore_db_cluster_to_point_in_time;
mod restore_db_instance_from_db_snapshot;
mod restore_db_instance_from_s3;
mod restore_db_instance_to_point_in_time;
mod revoke_db_security_group_ingress;
mod start_activity_stream;
mod start_db_cluster;
mod start_db_instance;
mod start_db_instance_automated_backups_replication;
mod start_export_task;
mod stop_activity_stream;
mod stop_db_cluster;
mod stop_db_instance;
mod stop_db_instance_automated_backups_replication;
mod switchover_blue_green_deployment;
mod switchover_global_cluster;
mod switchover_read_replica;