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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_db_cluster_snapshots::_describe_db_cluster_snapshots_output::DescribeDbClusterSnapshotsOutputBuilder;
pub use crate::operation::describe_db_cluster_snapshots::_describe_db_cluster_snapshots_input::DescribeDbClusterSnapshotsInputBuilder;
impl DescribeDbClusterSnapshotsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.describe_db_cluster_snapshots();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `DescribeDBClusterSnapshots`.
///
/// <p>Returns information about DB cluster snapshots. This API action supports pagination.</p>
/// <p>For more information on Amazon Aurora DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
/// <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeDBClusterSnapshotsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_db_cluster_snapshots::builders::DescribeDbClusterSnapshotsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput,
crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError,
> for DescribeDBClusterSnapshotsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput,
crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl DescribeDBClusterSnapshotsFluentBuilder {
/// Creates a new `DescribeDBClusterSnapshots`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the DescribeDBClusterSnapshots as a reference.
pub fn as_input(&self) -> &crate::operation::describe_db_cluster_snapshots::builders::DescribeDbClusterSnapshotsInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshots::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshots::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput,
crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::describe_db_cluster_snapshots::paginator::DescribeDbClusterSnapshotsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::describe_db_cluster_snapshots::paginator::DescribeDbClusterSnapshotsPaginator {
crate::operation::describe_db_cluster_snapshots::paginator::DescribeDbClusterSnapshotsPaginator::new(self.handle, self.inner)
}
/// <p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DBCluster.</p></li>
/// </ul>
pub fn db_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.db_cluster_identifier(input.into());
self
}
/// <p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DBCluster.</p></li>
/// </ul>
pub fn set_db_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_db_cluster_identifier(input);
self
}
/// <p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DBCluster.</p></li>
/// </ul>
pub fn get_db_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_db_cluster_identifier()
}
/// <p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p></li>
/// <li>
/// <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p></li>
/// </ul>
pub fn db_cluster_snapshot_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.db_cluster_snapshot_identifier(input.into());
self
}
/// <p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p></li>
/// <li>
/// <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p></li>
/// </ul>
pub fn set_db_cluster_snapshot_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_db_cluster_snapshot_identifier(input);
self
}
/// <p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p></li>
/// <li>
/// <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p></li>
/// </ul>
pub fn get_db_cluster_snapshot_identifier(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_db_cluster_snapshot_identifier()
}
/// <p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>automated</code> - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>manual</code> - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>shared</code> - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>public</code> - Return all DB cluster snapshots that have been marked as public.</p></li>
/// </ul>
/// <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the <code>IncludeShared</code> parameter. You can include public DB cluster snapshots with these results by enabling the <code>IncludePublic</code> parameter.</p>
/// <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>
pub fn snapshot_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.snapshot_type(input.into());
self
}
/// <p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>automated</code> - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>manual</code> - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>shared</code> - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>public</code> - Return all DB cluster snapshots that have been marked as public.</p></li>
/// </ul>
/// <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the <code>IncludeShared</code> parameter. You can include public DB cluster snapshots with these results by enabling the <code>IncludePublic</code> parameter.</p>
/// <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>
pub fn set_snapshot_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_snapshot_type(input);
self
}
/// <p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>automated</code> - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>manual</code> - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>shared</code> - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.</p></li>
/// <li>
/// <p><code>public</code> - Return all DB cluster snapshots that have been marked as public.</p></li>
/// </ul>
/// <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the <code>IncludeShared</code> parameter. You can include public DB cluster snapshots with these results by enabling the <code>IncludePublic</code> parameter.</p>
/// <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>
pub fn get_snapshot_type(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_snapshot_type()
}
/// Appends an item to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>A filter that specifies one or more DB cluster snapshots to describe.</p>
/// <p>Supported filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).</p></li>
/// <li>
/// <p><code>db-cluster-snapshot-id</code> - Accepts DB cluster snapshot identifiers.</p></li>
/// <li>
/// <p><code>snapshot-type</code> - Accepts types of DB cluster snapshots.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts names of database engines.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>A filter that specifies one or more DB cluster snapshots to describe.</p>
/// <p>Supported filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).</p></li>
/// <li>
/// <p><code>db-cluster-snapshot-id</code> - Accepts DB cluster snapshot identifiers.</p></li>
/// <li>
/// <p><code>snapshot-type</code> - Accepts types of DB cluster snapshots.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts names of database engines.</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>A filter that specifies one or more DB cluster snapshots to describe.</p>
/// <p>Supported filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).</p></li>
/// <li>
/// <p><code>db-cluster-snapshot-id</code> - Accepts DB cluster snapshot identifiers.</p></li>
/// <li>
/// <p><code>snapshot-type</code> - Accepts types of DB cluster snapshots.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts names of database engines.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
self.inner.get_filters()
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn max_records(mut self, input: i32) -> Self {
self.inner = self.inner.max_records(input);
self
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_records(input);
self
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn get_max_records(&self) -> &::std::option::Option<i32> {
self.inner.get_max_records()
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.marker(input.into());
self
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_marker(input);
self
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_marker()
}
/// <p>Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.</p>
/// <p>You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
pub fn include_shared(mut self, input: bool) -> Self {
self.inner = self.inner.include_shared(input);
self
}
/// <p>Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.</p>
/// <p>You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
pub fn set_include_shared(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_include_shared(input);
self
}
/// <p>Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.</p>
/// <p>You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
pub fn get_include_shared(&self) -> &::std::option::Option<bool> {
self.inner.get_include_shared()
}
/// <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
/// <p>You can share a manual DB cluster snapshot as public by using the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
pub fn include_public(mut self, input: bool) -> Self {
self.inner = self.inner.include_public(input);
self
}
/// <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
/// <p>You can share a manual DB cluster snapshot as public by using the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
pub fn set_include_public(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_include_public(input);
self
}
/// <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
/// <p>You can share a manual DB cluster snapshot as public by using the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p>
pub fn get_include_public(&self) -> &::std::option::Option<bool> {
self.inner.get_include_public()
}
/// <p>A specific DB cluster resource ID to describe.</p>
pub fn db_cluster_resource_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.db_cluster_resource_id(input.into());
self
}
/// <p>A specific DB cluster resource ID to describe.</p>
pub fn set_db_cluster_resource_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_db_cluster_resource_id(input);
self
}
/// <p>A specific DB cluster resource ID to describe.</p>
pub fn get_db_cluster_resource_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_db_cluster_resource_id()
}
}