aws_sdk_networkflowmonitor/operation/create_scope/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_scope::_create_scope_output::CreateScopeOutputBuilder;
3
4pub use crate::operation::create_scope::_create_scope_input::CreateScopeInputBuilder;
5
6impl crate::operation::create_scope::builders::CreateScopeInputBuilder {
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_scope::CreateScopeOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_scope::CreateScopeError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_scope();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateScope`.
24///
25/// <p>In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.</p>
26/// <p>A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.</p>
27/// <p>To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:</p>
28/// <ul>
29/// <li>
30/// <p><i>Targets</i>, which are arrays of targetResources.</p></li>
31/// <li>
32/// <p><i>Target resources</i>, which are Region-targetIdentifier pairs.</p></li>
33/// <li>
34/// <p><i>Target identifiers</i>, made up of a targetID (currently always an account ID) and a targetType (currently always an account).</p></li>
35/// </ul>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct CreateScopeFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::create_scope::builders::CreateScopeInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::create_scope::CreateScopeOutput,
45        crate::operation::create_scope::CreateScopeError,
46    > for CreateScopeFluentBuilder
47{
48    fn send(
49        self,
50        config_override: crate::config::Builder,
51    ) -> crate::client::customize::internal::BoxFuture<
52        crate::client::customize::internal::SendResult<
53            crate::operation::create_scope::CreateScopeOutput,
54            crate::operation::create_scope::CreateScopeError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl CreateScopeFluentBuilder {
61    /// Creates a new `CreateScopeFluentBuilder`.
62    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
63        Self {
64            handle,
65            inner: ::std::default::Default::default(),
66            config_override: ::std::option::Option::None,
67        }
68    }
69    /// Access the CreateScope as a reference.
70    pub fn as_input(&self) -> &crate::operation::create_scope::builders::CreateScopeInputBuilder {
71        &self.inner
72    }
73    /// Sends the request and returns the response.
74    ///
75    /// If an error occurs, an `SdkError` will be returned with additional details that
76    /// can be matched against.
77    ///
78    /// By default, any retryable failures will be retried twice. Retry behavior
79    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
80    /// set when configuring the client.
81    pub async fn send(
82        self,
83    ) -> ::std::result::Result<
84        crate::operation::create_scope::CreateScopeOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::create_scope::CreateScopeError,
87            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
88        >,
89    > {
90        let input = self
91            .inner
92            .build()
93            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
94        let runtime_plugins = crate::operation::create_scope::CreateScope::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::create_scope::CreateScope::orchestrate(&runtime_plugins, input).await
100    }
101
102    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
103    pub fn customize(
104        self,
105    ) -> crate::client::customize::CustomizableOperation<
106        crate::operation::create_scope::CreateScopeOutput,
107        crate::operation::create_scope::CreateScopeError,
108        Self,
109    > {
110        crate::client::customize::CustomizableOperation::new(self)
111    }
112    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
113        self.set_config_override(::std::option::Option::Some(config_override.into()));
114        self
115    }
116
117    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
118        self.config_override = config_override;
119        self
120    }
121    ///
122    /// Appends an item to `targets`.
123    ///
124    /// To override the contents of this collection use [`set_targets`](Self::set_targets).
125    ///
126    /// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
127    pub fn targets(mut self, input: crate::types::TargetResource) -> Self {
128        self.inner = self.inner.targets(input);
129        self
130    }
131    /// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
132    pub fn set_targets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TargetResource>>) -> Self {
133        self.inner = self.inner.set_targets(input);
134        self
135    }
136    /// <p>The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.</p>
137    pub fn get_targets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TargetResource>> {
138        self.inner.get_targets()
139    }
140    /// <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p>
141    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.client_token(input.into());
143        self
144    }
145    /// <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p>
146    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_client_token(input);
148        self
149    }
150    /// <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p>
151    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_client_token()
153    }
154    ///
155    /// Adds a key-value pair to `tags`.
156    ///
157    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
158    ///
159    /// <p>The tags for a scope. You can add a maximum of 200 tags.</p>
160    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.tags(k.into(), v.into());
162        self
163    }
164    /// <p>The tags for a scope. You can add a maximum of 200 tags.</p>
165    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
166        self.inner = self.inner.set_tags(input);
167        self
168    }
169    /// <p>The tags for a scope. You can add a maximum of 200 tags.</p>
170    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
171        self.inner.get_tags()
172    }
173}
aws_sdk_networkflowmonitor/operation/create_scope/builders.rs

aws_sdk_networkflowmonitor/operation/create_scope/
builders.rs
