aws-sdk-ecs 1.128.0

AWS SDK for Amazon EC2 Container Service
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ExecuteCommandOutput {
    /// <p>The Amazon Resource Name (ARN) of the cluster.</p>
    pub cluster_arn: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the container.</p>
    pub container_arn: ::std::option::Option<::std::string::String>,
    /// <p>The name of the container.</p>
    pub container_name: ::std::option::Option<::std::string::String>,
    /// <p>Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify <code>true</code> for this value.</p>
    pub interactive: bool,
    /// <p>The details of the SSM session that was created for this instance of execute-command.</p>
    pub session: ::std::option::Option<crate::types::Session>,
    /// <p>The Amazon Resource Name (ARN) of the task.</p>
    pub task_arn: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl ExecuteCommandOutput {
    /// <p>The Amazon Resource Name (ARN) of the cluster.</p>
    pub fn cluster_arn(&self) -> ::std::option::Option<&str> {
        self.cluster_arn.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the container.</p>
    pub fn container_arn(&self) -> ::std::option::Option<&str> {
        self.container_arn.as_deref()
    }
    /// <p>The name of the container.</p>
    pub fn container_name(&self) -> ::std::option::Option<&str> {
        self.container_name.as_deref()
    }
    /// <p>Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify <code>true</code> for this value.</p>
    pub fn interactive(&self) -> bool {
        self.interactive
    }
    /// <p>The details of the SSM session that was created for this instance of execute-command.</p>
    pub fn session(&self) -> ::std::option::Option<&crate::types::Session> {
        self.session.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the task.</p>
    pub fn task_arn(&self) -> ::std::option::Option<&str> {
        self.task_arn.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for ExecuteCommandOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl ExecuteCommandOutput {
    /// Creates a new builder-style object to manufacture [`ExecuteCommandOutput`](crate::operation::execute_command::ExecuteCommandOutput).
    pub fn builder() -> crate::operation::execute_command::builders::ExecuteCommandOutputBuilder {
        crate::operation::execute_command::builders::ExecuteCommandOutputBuilder::default()
    }
}

/// A builder for [`ExecuteCommandOutput`](crate::operation::execute_command::ExecuteCommandOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ExecuteCommandOutputBuilder {
    pub(crate) cluster_arn: ::std::option::Option<::std::string::String>,
    pub(crate) container_arn: ::std::option::Option<::std::string::String>,
    pub(crate) container_name: ::std::option::Option<::std::string::String>,
    pub(crate) interactive: ::std::option::Option<bool>,
    pub(crate) session: ::std::option::Option<crate::types::Session>,
    pub(crate) task_arn: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl ExecuteCommandOutputBuilder {
    /// <p>The Amazon Resource Name (ARN) of the cluster.</p>
    pub fn cluster_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cluster_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the cluster.</p>
    pub fn set_cluster_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cluster_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the cluster.</p>
    pub fn get_cluster_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.cluster_arn
    }
    /// <p>The Amazon Resource Name (ARN) of the container.</p>
    pub fn container_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.container_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the container.</p>
    pub fn set_container_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.container_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the container.</p>
    pub fn get_container_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.container_arn
    }
    /// <p>The name of the container.</p>
    pub fn container_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.container_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the container.</p>
    pub fn set_container_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.container_name = input;
        self
    }
    /// <p>The name of the container.</p>
    pub fn get_container_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.container_name
    }
    /// <p>Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify <code>true</code> for this value.</p>
    pub fn interactive(mut self, input: bool) -> Self {
        self.interactive = ::std::option::Option::Some(input);
        self
    }
    /// <p>Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify <code>true</code> for this value.</p>
    pub fn set_interactive(mut self, input: ::std::option::Option<bool>) -> Self {
        self.interactive = input;
        self
    }
    /// <p>Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify <code>true</code> for this value.</p>
    pub fn get_interactive(&self) -> &::std::option::Option<bool> {
        &self.interactive
    }
    /// <p>The details of the SSM session that was created for this instance of execute-command.</p>
    pub fn session(mut self, input: crate::types::Session) -> Self {
        self.session = ::std::option::Option::Some(input);
        self
    }
    /// <p>The details of the SSM session that was created for this instance of execute-command.</p>
    pub fn set_session(mut self, input: ::std::option::Option<crate::types::Session>) -> Self {
        self.session = input;
        self
    }
    /// <p>The details of the SSM session that was created for this instance of execute-command.</p>
    pub fn get_session(&self) -> &::std::option::Option<crate::types::Session> {
        &self.session
    }
    /// <p>The Amazon Resource Name (ARN) of the task.</p>
    pub fn task_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.task_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the task.</p>
    pub fn set_task_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.task_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the task.</p>
    pub fn get_task_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.task_arn
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`ExecuteCommandOutput`](crate::operation::execute_command::ExecuteCommandOutput).
    pub fn build(self) -> crate::operation::execute_command::ExecuteCommandOutput {
        crate::operation::execute_command::ExecuteCommandOutput {
            cluster_arn: self.cluster_arn,
            container_arn: self.container_arn,
            container_name: self.container_name,
            interactive: self.interactive.unwrap_or_default(),
            session: self.session,
            task_arn: self.task_arn,
            _request_id: self._request_id,
        }
    }
}