aws_sdk_lambda/operation/put_runtime_management_config/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_runtime_management_config::_put_runtime_management_config_output::PutRuntimeManagementConfigOutputBuilder;
3
4pub use crate::operation::put_runtime_management_config::_put_runtime_management_config_input::PutRuntimeManagementConfigInputBuilder;
5
6impl crate::operation::put_runtime_management_config::builders::PutRuntimeManagementConfigInputBuilder {
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_runtime_management_config::PutRuntimeManagementConfigOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::put_runtime_management_config::PutRuntimeManagementConfigError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.put_runtime_management_config();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PutRuntimeManagementConfig`.
24///
25/// <p>Sets the runtime management configuration for a function's version. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html">Runtime updates</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct PutRuntimeManagementConfigFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::put_runtime_management_config::builders::PutRuntimeManagementConfigInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::put_runtime_management_config::PutRuntimeManagementConfigOutput,
35        crate::operation::put_runtime_management_config::PutRuntimeManagementConfigError,
36    > for PutRuntimeManagementConfigFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::put_runtime_management_config::PutRuntimeManagementConfigOutput,
44            crate::operation::put_runtime_management_config::PutRuntimeManagementConfigError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl PutRuntimeManagementConfigFluentBuilder {
51    /// Creates a new `PutRuntimeManagementConfigFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the PutRuntimeManagementConfig as a reference.
60    pub fn as_input(&self) -> &crate::operation::put_runtime_management_config::builders::PutRuntimeManagementConfigInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::put_runtime_management_config::PutRuntimeManagementConfigOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::put_runtime_management_config::PutRuntimeManagementConfigError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::put_runtime_management_config::PutRuntimeManagementConfig::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::put_runtime_management_config::PutRuntimeManagementConfig::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::put_runtime_management_config::PutRuntimeManagementConfigOutput,
97        crate::operation::put_runtime_management_config::PutRuntimeManagementConfigError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The name or ARN of the Lambda function.</p>
112    /// <p class="title"><b>Name formats</b></p>
113    /// <ul>
114    /// <li>
115    /// <p><b>Function name</b> – <code>my-function</code>.</p></li>
116    /// <li>
117    /// <p><b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p></li>
118    /// <li>
119    /// <p><b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p></li>
120    /// </ul>
121    /// <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>
122    pub fn function_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.function_name(input.into());
124        self
125    }
126    /// <p>The name or ARN of the Lambda function.</p>
127    /// <p class="title"><b>Name formats</b></p>
128    /// <ul>
129    /// <li>
130    /// <p><b>Function name</b> – <code>my-function</code>.</p></li>
131    /// <li>
132    /// <p><b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p></li>
133    /// <li>
134    /// <p><b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p></li>
135    /// </ul>
136    /// <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>
137    pub fn set_function_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_function_name(input);
139        self
140    }
141    /// <p>The name or ARN of the Lambda function.</p>
142    /// <p class="title"><b>Name formats</b></p>
143    /// <ul>
144    /// <li>
145    /// <p><b>Function name</b> – <code>my-function</code>.</p></li>
146    /// <li>
147    /// <p><b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p></li>
148    /// <li>
149    /// <p><b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p></li>
150    /// </ul>
151    /// <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>
152    pub fn get_function_name(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_function_name()
154    }
155    /// <p>Specify a version of the function. This can be <code>$LATEST</code> or a published version number. If no value is specified, the configuration for the <code>$LATEST</code> version is returned.</p>
156    pub fn qualifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157        self.inner = self.inner.qualifier(input.into());
158        self
159    }
160    /// <p>Specify a version of the function. This can be <code>$LATEST</code> or a published version number. If no value is specified, the configuration for the <code>$LATEST</code> version is returned.</p>
161    pub fn set_qualifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162        self.inner = self.inner.set_qualifier(input);
163        self
164    }
165    /// <p>Specify a version of the function. This can be <code>$LATEST</code> or a published version number. If no value is specified, the configuration for the <code>$LATEST</code> version is returned.</p>
166    pub fn get_qualifier(&self) -> &::std::option::Option<::std::string::String> {
167        self.inner.get_qualifier()
168    }
169    /// <p>Specify the runtime update mode.</p>
170    /// <ul>
171    /// <li>
172    /// <p><b>Auto (default)</b> - Automatically update to the most recent and secure runtime version using a <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase">Two-phase runtime version rollout</a>. This is the best choice for most customers to ensure they always benefit from runtime updates.</p></li>
173    /// <li>
174    /// <p><b>Function update</b> - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.</p></li>
175    /// <li>
176    /// <p><b>Manual</b> - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback">Roll back a runtime version</a>.</p></li>
177    /// </ul>
178    pub fn update_runtime_on(mut self, input: crate::types::UpdateRuntimeOn) -> Self {
179        self.inner = self.inner.update_runtime_on(input);
180        self
181    }
182    /// <p>Specify the runtime update mode.</p>
183    /// <ul>
184    /// <li>
185    /// <p><b>Auto (default)</b> - Automatically update to the most recent and secure runtime version using a <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase">Two-phase runtime version rollout</a>. This is the best choice for most customers to ensure they always benefit from runtime updates.</p></li>
186    /// <li>
187    /// <p><b>Function update</b> - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.</p></li>
188    /// <li>
189    /// <p><b>Manual</b> - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback">Roll back a runtime version</a>.</p></li>
190    /// </ul>
191    pub fn set_update_runtime_on(mut self, input: ::std::option::Option<crate::types::UpdateRuntimeOn>) -> Self {
192        self.inner = self.inner.set_update_runtime_on(input);
193        self
194    }
195    /// <p>Specify the runtime update mode.</p>
196    /// <ul>
197    /// <li>
198    /// <p><b>Auto (default)</b> - Automatically update to the most recent and secure runtime version using a <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase">Two-phase runtime version rollout</a>. This is the best choice for most customers to ensure they always benefit from runtime updates.</p></li>
199    /// <li>
200    /// <p><b>Function update</b> - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.</p></li>
201    /// <li>
202    /// <p><b>Manual</b> - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback">Roll back a runtime version</a>.</p></li>
203    /// </ul>
204    pub fn get_update_runtime_on(&self) -> &::std::option::Option<crate::types::UpdateRuntimeOn> {
205        self.inner.get_update_runtime_on()
206    }
207    /// <p>The ARN of the runtime version you want the function to use.</p><note>
208    /// <p>This is only required if you're using the <b>Manual</b> runtime update mode.</p>
209    /// </note>
210    pub fn runtime_version_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
211        self.inner = self.inner.runtime_version_arn(input.into());
212        self
213    }
214    /// <p>The ARN of the runtime version you want the function to use.</p><note>
215    /// <p>This is only required if you're using the <b>Manual</b> runtime update mode.</p>
216    /// </note>
217    pub fn set_runtime_version_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
218        self.inner = self.inner.set_runtime_version_arn(input);
219        self
220    }
221    /// <p>The ARN of the runtime version you want the function to use.</p><note>
222    /// <p>This is only required if you're using the <b>Manual</b> runtime update mode.</p>
223    /// </note>
224    pub fn get_runtime_version_arn(&self) -> &::std::option::Option<::std::string::String> {
225        self.inner.get_runtime_version_arn()
226    }
227}