aws_sdk_lambda/operation/put_function_recursion_config/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_function_recursion_config::_put_function_recursion_config_output::PutFunctionRecursionConfigOutputBuilder;
3
4pub use crate::operation::put_function_recursion_config::_put_function_recursion_config_input::PutFunctionRecursionConfigInputBuilder;
5
6impl crate::operation::put_function_recursion_config::builders::PutFunctionRecursionConfigInputBuilder {
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_function_recursion_config::PutFunctionRecursionConfigOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::put_function_recursion_config::PutFunctionRecursionConfigError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.put_function_recursion_config();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PutFunctionRecursionConfig`.
24///
25/// <p>Sets your function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-recursion.html">recursive loop detection</a> configuration.</p>
26/// <p>When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.</p>
27/// <p>Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to <code>Terminate</code>, it stops your function being invoked and notifies you.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct PutFunctionRecursionConfigFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::put_function_recursion_config::builders::PutFunctionRecursionConfigInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::put_function_recursion_config::PutFunctionRecursionConfigOutput,
37        crate::operation::put_function_recursion_config::PutFunctionRecursionConfigError,
38    > for PutFunctionRecursionConfigFluentBuilder
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::put_function_recursion_config::PutFunctionRecursionConfigOutput,
46            crate::operation::put_function_recursion_config::PutFunctionRecursionConfigError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl PutFunctionRecursionConfigFluentBuilder {
53    /// Creates a new `PutFunctionRecursionConfigFluentBuilder`.
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 PutFunctionRecursionConfig as a reference.
62    pub fn as_input(&self) -> &crate::operation::put_function_recursion_config::builders::PutFunctionRecursionConfigInputBuilder {
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::put_function_recursion_config::PutFunctionRecursionConfigOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::put_function_recursion_config::PutFunctionRecursionConfigError,
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::put_function_recursion_config::PutFunctionRecursionConfig::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::put_function_recursion_config::PutFunctionRecursionConfig::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::put_function_recursion_config::PutFunctionRecursionConfigOutput,
99        crate::operation::put_function_recursion_config::PutFunctionRecursionConfigError,
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 Lambda function.</p>
114    /// <p class="title"><b>Name formats</b></p>
115    /// <ul>
116    /// <li>
117    /// <p><b>Function name</b> – <code>my-function</code>.</p></li>
118    /// <li>
119    /// <p><b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p></li>
120    /// <li>
121    /// <p><b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p></li>
122    /// </ul>
123    /// <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
124    pub fn function_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
125        self.inner = self.inner.function_name(input.into());
126        self
127    }
128    /// <p>The name or ARN of the Lambda function.</p>
129    /// <p class="title"><b>Name formats</b></p>
130    /// <ul>
131    /// <li>
132    /// <p><b>Function name</b> – <code>my-function</code>.</p></li>
133    /// <li>
134    /// <p><b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p></li>
135    /// <li>
136    /// <p><b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p></li>
137    /// </ul>
138    /// <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
139    pub fn set_function_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_function_name(input);
141        self
142    }
143    /// <p>The name or ARN of the Lambda function.</p>
144    /// <p class="title"><b>Name formats</b></p>
145    /// <ul>
146    /// <li>
147    /// <p><b>Function name</b> – <code>my-function</code>.</p></li>
148    /// <li>
149    /// <p><b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p></li>
150    /// <li>
151    /// <p><b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p></li>
152    /// </ul>
153    /// <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
154    pub fn get_function_name(&self) -> &::std::option::Option<::std::string::String> {
155        self.inner.get_function_name()
156    }
157    /// <p>If you set your function's recursive loop detection configuration to <code>Allow</code>, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.</p>
158    /// <p>If you set your function's recursive loop detection configuration to <code>Terminate</code>, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.</p>
159    /// <p>By default, Lambda sets your function's configuration to <code>Terminate</code>.</p><important>
160    /// <p>If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see <a href="https://serverlessland.com/content/service/lambda/guides/aws-lambda-operator-guide/recursive-runaway">Recursive patterns that cause run-away Lambda functions</a> in Serverless Land.</p>
161    /// </important>
162    pub fn recursive_loop(mut self, input: crate::types::RecursiveLoop) -> Self {
163        self.inner = self.inner.recursive_loop(input);
164        self
165    }
166    /// <p>If you set your function's recursive loop detection configuration to <code>Allow</code>, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.</p>
167    /// <p>If you set your function's recursive loop detection configuration to <code>Terminate</code>, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.</p>
168    /// <p>By default, Lambda sets your function's configuration to <code>Terminate</code>.</p><important>
169    /// <p>If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see <a href="https://serverlessland.com/content/service/lambda/guides/aws-lambda-operator-guide/recursive-runaway">Recursive patterns that cause run-away Lambda functions</a> in Serverless Land.</p>
170    /// </important>
171    pub fn set_recursive_loop(mut self, input: ::std::option::Option<crate::types::RecursiveLoop>) -> Self {
172        self.inner = self.inner.set_recursive_loop(input);
173        self
174    }
175    /// <p>If you set your function's recursive loop detection configuration to <code>Allow</code>, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.</p>
176    /// <p>If you set your function's recursive loop detection configuration to <code>Terminate</code>, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.</p>
177    /// <p>By default, Lambda sets your function's configuration to <code>Terminate</code>.</p><important>
178    /// <p>If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see <a href="https://serverlessland.com/content/service/lambda/guides/aws-lambda-operator-guide/recursive-runaway">Recursive patterns that cause run-away Lambda functions</a> in Serverless Land.</p>
179    /// </important>
180    pub fn get_recursive_loop(&self) -> &::std::option::Option<crate::types::RecursiveLoop> {
181        self.inner.get_recursive_loop()
182    }
183}