aws_sdk_ecs/operation/execute_command/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::execute_command::_execute_command_output::ExecuteCommandOutputBuilder;
3
4pub use crate::operation::execute_command::_execute_command_input::ExecuteCommandInputBuilder;
5
6impl crate::operation::execute_command::builders::ExecuteCommandInputBuilder {
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::execute_command::ExecuteCommandOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::execute_command::ExecuteCommandError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.execute_command();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ExecuteCommand`.
24///
25/// <p>Runs a command remotely on a container within a task.</p>
26/// <p>If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an <code>AccessDeniedException</code> when there is a mismatch between the condition key value and the corresponding parameter value.</p>
27/// <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using Amazon ECS Exec for debugging</a> in the <i>Amazon ECS Developer Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct ExecuteCommandFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::execute_command::builders::ExecuteCommandInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::execute_command::ExecuteCommandOutput,
37        crate::operation::execute_command::ExecuteCommandError,
38    > for ExecuteCommandFluentBuilder
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::execute_command::ExecuteCommandOutput,
46            crate::operation::execute_command::ExecuteCommandError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl ExecuteCommandFluentBuilder {
53    /// Creates a new `ExecuteCommandFluentBuilder`.
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 ExecuteCommand as a reference.
62    pub fn as_input(&self) -> &crate::operation::execute_command::builders::ExecuteCommandInputBuilder {
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::execute_command::ExecuteCommandOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::execute_command::ExecuteCommandError,
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::execute_command::ExecuteCommand::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::execute_command::ExecuteCommand::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::execute_command::ExecuteCommandOutput,
99        crate::operation::execute_command::ExecuteCommandError,
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 Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.</p>
114    pub fn cluster(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.cluster(input.into());
116        self
117    }
118    /// <p>The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.</p>
119    pub fn set_cluster(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_cluster(input);
121        self
122    }
123    /// <p>The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.</p>
124    pub fn get_cluster(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_cluster()
126    }
127    /// <p>The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.</p>
128    pub fn container(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.container(input.into());
130        self
131    }
132    /// <p>The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.</p>
133    pub fn set_container(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_container(input);
135        self
136    }
137    /// <p>The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.</p>
138    pub fn get_container(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_container()
140    }
141    /// <p>The command to run on the container.</p>
142    pub fn command(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.command(input.into());
144        self
145    }
146    /// <p>The command to run on the container.</p>
147    pub fn set_command(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_command(input);
149        self
150    }
151    /// <p>The command to run on the container.</p>
152    pub fn get_command(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_command()
154    }
155    /// <p>Use this flag to run your command in interactive mode.</p>
156    pub fn interactive(mut self, input: bool) -> Self {
157        self.inner = self.inner.interactive(input);
158        self
159    }
160    /// <p>Use this flag to run your command in interactive mode.</p>
161    pub fn set_interactive(mut self, input: ::std::option::Option<bool>) -> Self {
162        self.inner = self.inner.set_interactive(input);
163        self
164    }
165    /// <p>Use this flag to run your command in interactive mode.</p>
166    pub fn get_interactive(&self) -> &::std::option::Option<bool> {
167        self.inner.get_interactive()
168    }
169    /// <p>The Amazon Resource Name (ARN) or ID of the task the container is part of.</p>
170    pub fn task(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.inner = self.inner.task(input.into());
172        self
173    }
174    /// <p>The Amazon Resource Name (ARN) or ID of the task the container is part of.</p>
175    pub fn set_task(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.inner = self.inner.set_task(input);
177        self
178    }
179    /// <p>The Amazon Resource Name (ARN) or ID of the task the container is part of.</p>
180    pub fn get_task(&self) -> &::std::option::Option<::std::string::String> {
181        self.inner.get_task()
182    }
183}
aws_sdk_ecs/operation/execute_command/builders.rs

aws_sdk_ecs/operation/execute_command/
builders.rs
