aws-sdk-ssm 1.112.0

AWS SDK for Amazon Simple Systems Manager (SSM)
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with Amazon Web Services Systems Manager is called a managed node.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Activation {
    /// <p>The ID created by Systems Manager when you submitted the activation.</p>
    pub activation_id: ::std::option::Option<::std::string::String>,
    /// <p>A user defined description of the activation.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>A name for the managed node when it is created.</p>
    pub default_instance_name: ::std::option::Option<::std::string::String>,
    /// <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
    pub iam_role: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of managed nodes that can be registered using this activation.</p>
    pub registration_limit: ::std::option::Option<i32>,
    /// <p>The number of managed nodes already registered with this activation.</p>
    pub registrations_count: ::std::option::Option<i32>,
    /// <p>The date when this activation can no longer be used to register managed nodes.</p>
    pub expiration_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Whether or not the activation is expired.</p>
    pub expired: bool,
    /// <p>The date the activation was created.</p>
    pub created_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Tags assigned to the activation.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl Activation {
    /// <p>The ID created by Systems Manager when you submitted the activation.</p>
    pub fn activation_id(&self) -> ::std::option::Option<&str> {
        self.activation_id.as_deref()
    }
    /// <p>A user defined description of the activation.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>A name for the managed node when it is created.</p>
    pub fn default_instance_name(&self) -> ::std::option::Option<&str> {
        self.default_instance_name.as_deref()
    }
    /// <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
    pub fn iam_role(&self) -> ::std::option::Option<&str> {
        self.iam_role.as_deref()
    }
    /// <p>The maximum number of managed nodes that can be registered using this activation.</p>
    pub fn registration_limit(&self) -> ::std::option::Option<i32> {
        self.registration_limit
    }
    /// <p>The number of managed nodes already registered with this activation.</p>
    pub fn registrations_count(&self) -> ::std::option::Option<i32> {
        self.registrations_count
    }
    /// <p>The date when this activation can no longer be used to register managed nodes.</p>
    pub fn expiration_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.expiration_date.as_ref()
    }
    /// <p>Whether or not the activation is expired.</p>
    pub fn expired(&self) -> bool {
        self.expired
    }
    /// <p>The date the activation was created.</p>
    pub fn created_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_date.as_ref()
    }
    /// <p>Tags assigned to the activation.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
}
impl Activation {
    /// Creates a new builder-style object to manufacture [`Activation`](crate::types::Activation).
    pub fn builder() -> crate::types::builders::ActivationBuilder {
        crate::types::builders::ActivationBuilder::default()
    }
}

/// A builder for [`Activation`](crate::types::Activation).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ActivationBuilder {
    pub(crate) activation_id: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) default_instance_name: ::std::option::Option<::std::string::String>,
    pub(crate) iam_role: ::std::option::Option<::std::string::String>,
    pub(crate) registration_limit: ::std::option::Option<i32>,
    pub(crate) registrations_count: ::std::option::Option<i32>,
    pub(crate) expiration_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) expired: ::std::option::Option<bool>,
    pub(crate) created_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl ActivationBuilder {
    /// <p>The ID created by Systems Manager when you submitted the activation.</p>
    pub fn activation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.activation_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID created by Systems Manager when you submitted the activation.</p>
    pub fn set_activation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.activation_id = input;
        self
    }
    /// <p>The ID created by Systems Manager when you submitted the activation.</p>
    pub fn get_activation_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.activation_id
    }
    /// <p>A user defined description of the activation.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A user defined description of the activation.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A user defined description of the activation.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>A name for the managed node when it is created.</p>
    pub fn default_instance_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.default_instance_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A name for the managed node when it is created.</p>
    pub fn set_default_instance_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.default_instance_name = input;
        self
    }
    /// <p>A name for the managed node when it is created.</p>
    pub fn get_default_instance_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.default_instance_name
    }
    /// <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
    pub fn iam_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.iam_role = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
    pub fn set_iam_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.iam_role = input;
        self
    }
    /// <p>The Identity and Access Management (IAM) role to assign to the managed node.</p>
    pub fn get_iam_role(&self) -> &::std::option::Option<::std::string::String> {
        &self.iam_role
    }
    /// <p>The maximum number of managed nodes that can be registered using this activation.</p>
    pub fn registration_limit(mut self, input: i32) -> Self {
        self.registration_limit = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of managed nodes that can be registered using this activation.</p>
    pub fn set_registration_limit(mut self, input: ::std::option::Option<i32>) -> Self {
        self.registration_limit = input;
        self
    }
    /// <p>The maximum number of managed nodes that can be registered using this activation.</p>
    pub fn get_registration_limit(&self) -> &::std::option::Option<i32> {
        &self.registration_limit
    }
    /// <p>The number of managed nodes already registered with this activation.</p>
    pub fn registrations_count(mut self, input: i32) -> Self {
        self.registrations_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of managed nodes already registered with this activation.</p>
    pub fn set_registrations_count(mut self, input: ::std::option::Option<i32>) -> Self {
        self.registrations_count = input;
        self
    }
    /// <p>The number of managed nodes already registered with this activation.</p>
    pub fn get_registrations_count(&self) -> &::std::option::Option<i32> {
        &self.registrations_count
    }
    /// <p>The date when this activation can no longer be used to register managed nodes.</p>
    pub fn expiration_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.expiration_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date when this activation can no longer be used to register managed nodes.</p>
    pub fn set_expiration_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.expiration_date = input;
        self
    }
    /// <p>The date when this activation can no longer be used to register managed nodes.</p>
    pub fn get_expiration_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.expiration_date
    }
    /// <p>Whether or not the activation is expired.</p>
    pub fn expired(mut self, input: bool) -> Self {
        self.expired = ::std::option::Option::Some(input);
        self
    }
    /// <p>Whether or not the activation is expired.</p>
    pub fn set_expired(mut self, input: ::std::option::Option<bool>) -> Self {
        self.expired = input;
        self
    }
    /// <p>Whether or not the activation is expired.</p>
    pub fn get_expired(&self) -> &::std::option::Option<bool> {
        &self.expired
    }
    /// <p>The date the activation was created.</p>
    pub fn created_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date the activation was created.</p>
    pub fn set_created_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_date = input;
        self
    }
    /// <p>The date the activation was created.</p>
    pub fn get_created_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_date
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Tags assigned to the activation.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>Tags assigned to the activation.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Tags assigned to the activation.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`Activation`](crate::types::Activation).
    pub fn build(self) -> crate::types::Activation {
        crate::types::Activation {
            activation_id: self.activation_id,
            description: self.description,
            default_instance_name: self.default_instance_name,
            iam_role: self.iam_role,
            registration_limit: self.registration_limit,
            registrations_count: self.registrations_count,
            expiration_date: self.expiration_date,
            expired: self.expired.unwrap_or_default(),
            created_date: self.created_date,
            tags: self.tags,
        }
    }
}