aws_sdk_cloudtrail/operation/update_dashboard/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_dashboard::_update_dashboard_output::UpdateDashboardOutputBuilder;
3
4pub use crate::operation::update_dashboard::_update_dashboard_input::UpdateDashboardInputBuilder;
5
6impl crate::operation::update_dashboard::builders::UpdateDashboardInputBuilder {
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::update_dashboard::UpdateDashboardOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_dashboard::UpdateDashboardError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_dashboard();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateDashboard`.
24///
25/// <p>Updates the specified dashboard.</p>
26/// <p>To set a refresh schedule, CloudTrail must be granted permissions to run the <code>StartDashboardRefresh</code> operation to refresh the dashboard on your behalf. To provide permissions, run the <code>PutResourcePolicy</code> operation to attach a resource-based policy to the dashboard. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-dashboards"> Resource-based policy example for a dashboard</a> in the <i>CloudTrail User Guide</i>.</p>
27/// <p>CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the <code>StartQuery</code> operation on your behalf. To provide permissions, run the <code>PutResourcePolicy</code> operation to attach a resource-based policy to each event data store. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard">Example: Allow CloudTrail to run queries to populate a dashboard</a> in the <i>CloudTrail User Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdateDashboardFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::update_dashboard::builders::UpdateDashboardInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::update_dashboard::UpdateDashboardOutput,
37        crate::operation::update_dashboard::UpdateDashboardError,
38    > for UpdateDashboardFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::update_dashboard::UpdateDashboardOutput,
46            crate::operation::update_dashboard::UpdateDashboardError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl UpdateDashboardFluentBuilder {
53    /// Creates a new `UpdateDashboardFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the UpdateDashboard as a reference.
62    pub fn as_input(&self) -> &crate::operation::update_dashboard::builders::UpdateDashboardInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::update_dashboard::UpdateDashboardOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::update_dashboard::UpdateDashboardError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::update_dashboard::UpdateDashboard::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::update_dashboard::UpdateDashboard::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::update_dashboard::UpdateDashboardOutput,
99        crate::operation::update_dashboard::UpdateDashboardError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The name or ARN of the dashboard.</p>
114    pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.dashboard_id(input.into());
116        self
117    }
118    /// <p>The name or ARN of the dashboard.</p>
119    pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_dashboard_id(input);
121        self
122    }
123    /// <p>The name or ARN of the dashboard.</p>
124    pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_dashboard_id()
126    }
127    ///
128    /// Appends an item to `Widgets`.
129    ///
130    /// To override the contents of this collection use [`set_widgets`](Self::set_widgets).
131    ///
132    /// <p>An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.</p>
133    /// <p>To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the <code>GetDashboard</code> operation to get the list of widgets for the dashboard.</p>
134    /// <p>To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.</p>
135    pub fn widgets(mut self, input: crate::types::RequestWidget) -> Self {
136        self.inner = self.inner.widgets(input);
137        self
138    }
139    /// <p>An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.</p>
140    /// <p>To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the <code>GetDashboard</code> operation to get the list of widgets for the dashboard.</p>
141    /// <p>To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.</p>
142    pub fn set_widgets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RequestWidget>>) -> Self {
143        self.inner = self.inner.set_widgets(input);
144        self
145    }
146    /// <p>An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.</p>
147    /// <p>To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the <code>GetDashboard</code> operation to get the list of widgets for the dashboard.</p>
148    /// <p>To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.</p>
149    pub fn get_widgets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RequestWidget>> {
150        self.inner.get_widgets()
151    }
152    /// <p>The refresh schedule configuration for the dashboard.</p>
153    pub fn refresh_schedule(mut self, input: crate::types::RefreshSchedule) -> Self {
154        self.inner = self.inner.refresh_schedule(input);
155        self
156    }
157    /// <p>The refresh schedule configuration for the dashboard.</p>
158    pub fn set_refresh_schedule(mut self, input: ::std::option::Option<crate::types::RefreshSchedule>) -> Self {
159        self.inner = self.inner.set_refresh_schedule(input);
160        self
161    }
162    /// <p>The refresh schedule configuration for the dashboard.</p>
163    pub fn get_refresh_schedule(&self) -> &::std::option::Option<crate::types::RefreshSchedule> {
164        self.inner.get_refresh_schedule()
165    }
166    /// <p>Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.</p>
167    pub fn termination_protection_enabled(mut self, input: bool) -> Self {
168        self.inner = self.inner.termination_protection_enabled(input);
169        self
170    }
171    /// <p>Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.</p>
172    pub fn set_termination_protection_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
173        self.inner = self.inner.set_termination_protection_enabled(input);
174        self
175    }
176    /// <p>Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.</p>
177    pub fn get_termination_protection_enabled(&self) -> &::std::option::Option<bool> {
178        self.inner.get_termination_protection_enabled()
179    }
180}
aws_sdk_cloudtrail/operation/update_dashboard/builders.rs

aws_sdk_cloudtrail/operation/update_dashboard/
builders.rs
