// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_dashboard::_create_dashboard_input::CreateDashboardInputBuilder;
pub use crate::operation::create_dashboard::_create_dashboard_output::CreateDashboardOutputBuilder;
impl crate::operation::create_dashboard::builders::CreateDashboardInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::create_dashboard::CreateDashboardOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_dashboard::CreateDashboardError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.create_dashboard();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `CreateDashboard`.
///
/// <p>Creates a custom dashboard or the Highlights dashboard.</p>
/// <ul>
/// <li>
/// <p><b>Custom dashboards</b> - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.</p></li>
/// <li>
/// <p><b>Highlights dashboard</b> - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.</p></li>
/// </ul>
/// <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>
/// <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>
/// <p>For more information about dashboards, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-dashboard.html">CloudTrail Lake dashboards</a> in the <i>CloudTrail User Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateDashboardFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_dashboard::builders::CreateDashboardInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::create_dashboard::CreateDashboardOutput,
crate::operation::create_dashboard::CreateDashboardError,
> for CreateDashboardFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::create_dashboard::CreateDashboardOutput,
crate::operation::create_dashboard::CreateDashboardError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl CreateDashboardFluentBuilder {
/// Creates a new `CreateDashboardFluentBuilder`.
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 CreateDashboard as a reference.
pub fn as_input(&self) -> &crate::operation::create_dashboard::builders::CreateDashboardInputBuilder {
&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::create_dashboard::CreateDashboardOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_dashboard::CreateDashboardError,
::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::create_dashboard::CreateDashboard::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::create_dashboard::CreateDashboard::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::create_dashboard::CreateDashboardOutput,
crate::operation::create_dashboard::CreateDashboardError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the dashboard. The name must be unique to your account.</p>
/// <p>To create the Highlights dashboard, the name must be <code>AWSCloudTrail-Highlights</code>.</p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The name of the dashboard. The name must be unique to your account.</p>
/// <p>To create the Highlights dashboard, the name must be <code>AWSCloudTrail-Highlights</code>.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>The name of the dashboard. The name must be unique to your account.</p>
/// <p>To create the Highlights dashboard, the name must be <code>AWSCloudTrail-Highlights</code>.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_name()
}
/// <p>The refresh schedule configuration for the dashboard.</p>
/// <p>To create the Highlights dashboard, you must set a refresh schedule and set the <code>Status</code> to <code>ENABLED</code>. The <code>Unit</code> for the refresh schedule must be <code>HOURS</code> and the <code>Value</code> must be <code>6</code>.</p>
pub fn refresh_schedule(mut self, input: crate::types::RefreshSchedule) -> Self {
self.inner = self.inner.refresh_schedule(input);
self
}
/// <p>The refresh schedule configuration for the dashboard.</p>
/// <p>To create the Highlights dashboard, you must set a refresh schedule and set the <code>Status</code> to <code>ENABLED</code>. The <code>Unit</code> for the refresh schedule must be <code>HOURS</code> and the <code>Value</code> must be <code>6</code>.</p>
pub fn set_refresh_schedule(mut self, input: ::std::option::Option<crate::types::RefreshSchedule>) -> Self {
self.inner = self.inner.set_refresh_schedule(input);
self
}
/// <p>The refresh schedule configuration for the dashboard.</p>
/// <p>To create the Highlights dashboard, you must set a refresh schedule and set the <code>Status</code> to <code>ENABLED</code>. The <code>Unit</code> for the refresh schedule must be <code>HOURS</code> and the <code>Value</code> must be <code>6</code>.</p>
pub fn get_refresh_schedule(&self) -> &::std::option::Option<crate::types::RefreshSchedule> {
self.inner.get_refresh_schedule()
}
///
/// Appends an item to `TagsList`.
///
/// To override the contents of this collection use [`set_tags_list`](Self::set_tags_list).
///
/// <p>A list of tags.</p>
pub fn tags_list(mut self, input: crate::types::Tag) -> Self {
self.inner = self.inner.tags_list(input);
self
}
/// <p>A list of tags.</p>
pub fn set_tags_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.inner = self.inner.set_tags_list(input);
self
}
/// <p>A list of tags.</p>
pub fn get_tags_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
self.inner.get_tags_list()
}
/// <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>
pub fn termination_protection_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.termination_protection_enabled(input);
self
}
/// <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>
pub fn set_termination_protection_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_termination_protection_enabled(input);
self
}
/// <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>
pub fn get_termination_protection_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_termination_protection_enabled()
}
///
/// Appends an item to `Widgets`.
///
/// To override the contents of this collection use [`set_widgets`](Self::set_widgets).
///
/// <p>An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.</p>
/// <p>You do not need to specify widgets for the Highlights dashboard.</p>
pub fn widgets(mut self, input: crate::types::RequestWidget) -> Self {
self.inner = self.inner.widgets(input);
self
}
/// <p>An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.</p>
/// <p>You do not need to specify widgets for the Highlights dashboard.</p>
pub fn set_widgets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RequestWidget>>) -> Self {
self.inner = self.inner.set_widgets(input);
self
}
/// <p>An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.</p>
/// <p>You do not need to specify widgets for the Highlights dashboard.</p>
pub fn get_widgets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RequestWidget>> {
self.inner.get_widgets()
}
}