aws_sdk_backup/operation/create_report_plan/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_report_plan::_create_report_plan_output::CreateReportPlanOutputBuilder;
3
4pub use crate::operation::create_report_plan::_create_report_plan_input::CreateReportPlanInputBuilder;
5
6impl crate::operation::create_report_plan::builders::CreateReportPlanInputBuilder {
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::create_report_plan::CreateReportPlanOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_report_plan::CreateReportPlanError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_report_plan();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateReportPlan`.
24///
25/// <p>Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.</p>
26/// <p>If you call <code>CreateReportPlan</code> with a plan that already exists, you receive an <code>AlreadyExistsException</code> exception.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateReportPlanFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_report_plan::builders::CreateReportPlanInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_report_plan::CreateReportPlanOutput,
36        crate::operation::create_report_plan::CreateReportPlanError,
37    > for CreateReportPlanFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::create_report_plan::CreateReportPlanOutput,
45            crate::operation::create_report_plan::CreateReportPlanError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateReportPlanFluentBuilder {
52    /// Creates a new `CreateReportPlanFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the CreateReportPlan as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_report_plan::builders::CreateReportPlanInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::create_report_plan::CreateReportPlanOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_report_plan::CreateReportPlanError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::create_report_plan::CreateReportPlan::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_report_plan::CreateReportPlan::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::create_report_plan::CreateReportPlanOutput,
98        crate::operation::create_report_plan::CreateReportPlanError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
113    pub fn report_plan_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.report_plan_name(input.into());
115        self
116    }
117    /// <p>The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
118    pub fn set_report_plan_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_report_plan_name(input);
120        self
121    }
122    /// <p>The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
123    pub fn get_report_plan_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_report_plan_name()
125    }
126    /// <p>An optional description of the report plan with a maximum of 1,024 characters.</p>
127    pub fn report_plan_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.report_plan_description(input.into());
129        self
130    }
131    /// <p>An optional description of the report plan with a maximum of 1,024 characters.</p>
132    pub fn set_report_plan_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_report_plan_description(input);
134        self
135    }
136    /// <p>An optional description of the report plan with a maximum of 1,024 characters.</p>
137    pub fn get_report_plan_description(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_report_plan_description()
139    }
140    /// <p>A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.</p>
141    pub fn report_delivery_channel(mut self, input: crate::types::ReportDeliveryChannel) -> Self {
142        self.inner = self.inner.report_delivery_channel(input);
143        self
144    }
145    /// <p>A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.</p>
146    pub fn set_report_delivery_channel(mut self, input: ::std::option::Option<crate::types::ReportDeliveryChannel>) -> Self {
147        self.inner = self.inner.set_report_delivery_channel(input);
148        self
149    }
150    /// <p>A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.</p>
151    pub fn get_report_delivery_channel(&self) -> &::std::option::Option<crate::types::ReportDeliveryChannel> {
152        self.inner.get_report_delivery_channel()
153    }
154    /// <p>Identifies the report template for the report. Reports are built using a report template. The report templates are:</p>
155    /// <p><code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</code></p>
156    /// <p>If the report template is <code>RESOURCE_COMPLIANCE_REPORT</code> or <code>CONTROL_COMPLIANCE_REPORT</code>, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.</p>
157    pub fn report_setting(mut self, input: crate::types::ReportSetting) -> Self {
158        self.inner = self.inner.report_setting(input);
159        self
160    }
161    /// <p>Identifies the report template for the report. Reports are built using a report template. The report templates are:</p>
162    /// <p><code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</code></p>
163    /// <p>If the report template is <code>RESOURCE_COMPLIANCE_REPORT</code> or <code>CONTROL_COMPLIANCE_REPORT</code>, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.</p>
164    pub fn set_report_setting(mut self, input: ::std::option::Option<crate::types::ReportSetting>) -> Self {
165        self.inner = self.inner.set_report_setting(input);
166        self
167    }
168    /// <p>Identifies the report template for the report. Reports are built using a report template. The report templates are:</p>
169    /// <p><code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</code></p>
170    /// <p>If the report template is <code>RESOURCE_COMPLIANCE_REPORT</code> or <code>CONTROL_COMPLIANCE_REPORT</code>, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.</p>
171    pub fn get_report_setting(&self) -> &::std::option::Option<crate::types::ReportSetting> {
172        self.inner.get_report_setting()
173    }
174    ///
175    /// Adds a key-value pair to `ReportPlanTags`.
176    ///
177    /// To override the contents of this collection use [`set_report_plan_tags`](Self::set_report_plan_tags).
178    ///
179    /// <p>The tags to assign to the report plan.</p>
180    pub fn report_plan_tags(
181        mut self,
182        k: impl ::std::convert::Into<::std::string::String>,
183        v: impl ::std::convert::Into<::std::string::String>,
184    ) -> Self {
185        self.inner = self.inner.report_plan_tags(k.into(), v.into());
186        self
187    }
188    /// <p>The tags to assign to the report plan.</p>
189    pub fn set_report_plan_tags(
190        mut self,
191        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
192    ) -> Self {
193        self.inner = self.inner.set_report_plan_tags(input);
194        self
195    }
196    /// <p>The tags to assign to the report plan.</p>
197    pub fn get_report_plan_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
198        self.inner.get_report_plan_tags()
199    }
200    /// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
201    pub fn idempotency_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
202        self.inner = self.inner.idempotency_token(input.into());
203        self
204    }
205    /// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
206    pub fn set_idempotency_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
207        self.inner = self.inner.set_idempotency_token(input);
208        self
209    }
210    /// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
211    pub fn get_idempotency_token(&self) -> &::std::option::Option<::std::string::String> {
212        self.inner.get_idempotency_token()
213    }
214}
aws_sdk_backup/operation/create_report_plan/builders.rs

aws_sdk_backup/operation/create_report_plan/
builders.rs
