aws_sdk_backup/operation/put_backup_vault_notifications/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_backup_vault_notifications::_put_backup_vault_notifications_output::PutBackupVaultNotificationsOutputBuilder;
3
4pub use crate::operation::put_backup_vault_notifications::_put_backup_vault_notifications_input::PutBackupVaultNotificationsInputBuilder;
5
6impl crate::operation::put_backup_vault_notifications::builders::PutBackupVaultNotificationsInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.put_backup_vault_notifications();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `PutBackupVaultNotifications`.
24///
25/// <p>Turns on notifications on a backup vault for the specified topic and events.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct PutBackupVaultNotificationsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::put_backup_vault_notifications::builders::PutBackupVaultNotificationsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsOutput,
35 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsError,
36 > for PutBackupVaultNotificationsFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsOutput,
44 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl PutBackupVaultNotificationsFluentBuilder {
51 /// Creates a new `PutBackupVaultNotificationsFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the PutBackupVaultNotifications as a reference.
60 pub fn as_input(&self) -> &crate::operation::put_backup_vault_notifications::builders::PutBackupVaultNotificationsInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::put_backup_vault_notifications::PutBackupVaultNotifications::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::put_backup_vault_notifications::PutBackupVaultNotifications::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsOutput,
97 crate::operation::put_backup_vault_notifications::PutBackupVaultNotificationsError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
112 pub fn backup_vault_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.backup_vault_name(input.into());
114 self
115 }
116 /// <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
117 pub fn set_backup_vault_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_backup_vault_name(input);
119 self
120 }
121 /// <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
122 pub fn get_backup_vault_name(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_backup_vault_name()
124 }
125 /// <p>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, <code>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</code>.</p>
126 pub fn sns_topic_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.sns_topic_arn(input.into());
128 self
129 }
130 /// <p>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, <code>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</code>.</p>
131 pub fn set_sns_topic_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_sns_topic_arn(input);
133 self
134 }
135 /// <p>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, <code>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</code>.</p>
136 pub fn get_sns_topic_arn(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_sns_topic_arn()
138 }
139 ///
140 /// Appends an item to `BackupVaultEvents`.
141 ///
142 /// To override the contents of this collection use [`set_backup_vault_events`](Self::set_backup_vault_events).
143 ///
144 /// <p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p>
145 /// <p>For common use cases and code samples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html">Using Amazon SNS to track Backup events</a>.</p>
146 /// <p>The following events are supported:</p>
147 /// <ul>
148 /// <li>
149 /// <p><code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code></p></li>
150 /// <li>
151 /// <p><code>COPY_JOB_STARTED</code> | <code>COPY_JOB_SUCCESSFUL</code> | <code>COPY_JOB_FAILED</code></p></li>
152 /// <li>
153 /// <p><code>RESTORE_JOB_STARTED</code> | <code>RESTORE_JOB_COMPLETED</code> | <code>RECOVERY_POINT_MODIFIED</code></p></li>
154 /// <li>
155 /// <p><code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code></p></li>
156 /// </ul><note>
157 /// <p>The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.</p>
158 /// </note>
159 pub fn backup_vault_events(mut self, input: crate::types::BackupVaultEvent) -> Self {
160 self.inner = self.inner.backup_vault_events(input);
161 self
162 }
163 /// <p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p>
164 /// <p>For common use cases and code samples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html">Using Amazon SNS to track Backup events</a>.</p>
165 /// <p>The following events are supported:</p>
166 /// <ul>
167 /// <li>
168 /// <p><code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code></p></li>
169 /// <li>
170 /// <p><code>COPY_JOB_STARTED</code> | <code>COPY_JOB_SUCCESSFUL</code> | <code>COPY_JOB_FAILED</code></p></li>
171 /// <li>
172 /// <p><code>RESTORE_JOB_STARTED</code> | <code>RESTORE_JOB_COMPLETED</code> | <code>RECOVERY_POINT_MODIFIED</code></p></li>
173 /// <li>
174 /// <p><code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code></p></li>
175 /// </ul><note>
176 /// <p>The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.</p>
177 /// </note>
178 pub fn set_backup_vault_events(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::BackupVaultEvent>>) -> Self {
179 self.inner = self.inner.set_backup_vault_events(input);
180 self
181 }
182 /// <p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p>
183 /// <p>For common use cases and code samples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html">Using Amazon SNS to track Backup events</a>.</p>
184 /// <p>The following events are supported:</p>
185 /// <ul>
186 /// <li>
187 /// <p><code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code></p></li>
188 /// <li>
189 /// <p><code>COPY_JOB_STARTED</code> | <code>COPY_JOB_SUCCESSFUL</code> | <code>COPY_JOB_FAILED</code></p></li>
190 /// <li>
191 /// <p><code>RESTORE_JOB_STARTED</code> | <code>RESTORE_JOB_COMPLETED</code> | <code>RECOVERY_POINT_MODIFIED</code></p></li>
192 /// <li>
193 /// <p><code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code></p></li>
194 /// </ul><note>
195 /// <p>The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.</p>
196 /// </note>
197 pub fn get_backup_vault_events(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::BackupVaultEvent>> {
198 self.inner.get_backup_vault_events()
199 }
200}