aws_sdk_appstream/operation/create_fleet/_create_fleet_input.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct CreateFleetInput {
6 /// <p>A unique name for the fleet.</p>
7 pub name: ::std::option::Option<::std::string::String>,
8 /// <p>The name of the image used to create the fleet.</p>
9 pub image_name: ::std::option::Option<::std::string::String>,
10 /// <p>The ARN of the public, private, or shared image to use.</p>
11 pub image_arn: ::std::option::Option<::std::string::String>,
12 /// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
13 /// <ul>
14 /// <li>
15 /// <p>stream.standard.small</p></li>
16 /// <li>
17 /// <p>stream.standard.medium</p></li>
18 /// <li>
19 /// <p>stream.standard.large</p></li>
20 /// <li>
21 /// <p>stream.standard.xlarge</p></li>
22 /// <li>
23 /// <p>stream.standard.2xlarge</p></li>
24 /// <li>
25 /// <p>stream.compute.large</p></li>
26 /// <li>
27 /// <p>stream.compute.xlarge</p></li>
28 /// <li>
29 /// <p>stream.compute.2xlarge</p></li>
30 /// <li>
31 /// <p>stream.compute.4xlarge</p></li>
32 /// <li>
33 /// <p>stream.compute.8xlarge</p></li>
34 /// <li>
35 /// <p>stream.memory.large</p></li>
36 /// <li>
37 /// <p>stream.memory.xlarge</p></li>
38 /// <li>
39 /// <p>stream.memory.2xlarge</p></li>
40 /// <li>
41 /// <p>stream.memory.4xlarge</p></li>
42 /// <li>
43 /// <p>stream.memory.8xlarge</p></li>
44 /// <li>
45 /// <p>stream.memory.z1d.large</p></li>
46 /// <li>
47 /// <p>stream.memory.z1d.xlarge</p></li>
48 /// <li>
49 /// <p>stream.memory.z1d.2xlarge</p></li>
50 /// <li>
51 /// <p>stream.memory.z1d.3xlarge</p></li>
52 /// <li>
53 /// <p>stream.memory.z1d.6xlarge</p></li>
54 /// <li>
55 /// <p>stream.memory.z1d.12xlarge</p></li>
56 /// <li>
57 /// <p>stream.graphics.g4dn.xlarge</p></li>
58 /// <li>
59 /// <p>stream.graphics.g4dn.2xlarge</p></li>
60 /// <li>
61 /// <p>stream.graphics.g4dn.4xlarge</p></li>
62 /// <li>
63 /// <p>stream.graphics.g4dn.8xlarge</p></li>
64 /// <li>
65 /// <p>stream.graphics.g4dn.12xlarge</p></li>
66 /// <li>
67 /// <p>stream.graphics.g4dn.16xlarge</p></li>
68 /// <li>
69 /// <p>stream.graphics.g5.xlarge</p></li>
70 /// <li>
71 /// <p>stream.graphics.g5.2xlarge</p></li>
72 /// <li>
73 /// <p>stream.graphics.g5.4xlarge</p></li>
74 /// <li>
75 /// <p>stream.graphics.g5.8xlarge</p></li>
76 /// <li>
77 /// <p>stream.graphics.g5.12xlarge</p></li>
78 /// <li>
79 /// <p>stream.graphics.g5.16xlarge</p></li>
80 /// <li>
81 /// <p>stream.graphics.g5.24xlarge</p></li>
82 /// <li>
83 /// <p>stream.graphics.g6.xlarge</p></li>
84 /// <li>
85 /// <p>stream.graphics.g6.2xlarge</p></li>
86 /// <li>
87 /// <p>stream.graphics.g6.4xlarge</p></li>
88 /// <li>
89 /// <p>stream.graphics.g6.8xlarge</p></li>
90 /// <li>
91 /// <p>stream.graphics.g6.16xlarge</p></li>
92 /// <li>
93 /// <p>stream.graphics.g6.12xlarge</p></li>
94 /// <li>
95 /// <p>stream.graphics.g6.24xlarge</p></li>
96 /// <li>
97 /// <p>stream.graphics.gr6.4xlarge</p></li>
98 /// <li>
99 /// <p>stream.graphics.gr6.8xlarge</p></li>
100 /// <li>
101 /// <p>stream.graphics.g6f.large</p></li>
102 /// <li>
103 /// <p>stream.graphics.g6f.xlarge</p></li>
104 /// <li>
105 /// <p>stream.graphics.g6f.2xlarge</p></li>
106 /// <li>
107 /// <p>stream.graphics.g6f.4xlarge</p></li>
108 /// <li>
109 /// <p>stream.graphics.gr6f.4xlarge</p></li>
110 /// </ul>
111 /// <p>The following instance types are available for Elastic fleets:</p>
112 /// <ul>
113 /// <li>
114 /// <p>stream.standard.small</p></li>
115 /// <li>
116 /// <p>stream.standard.medium</p></li>
117 /// <li>
118 /// <p>stream.standard.large</p></li>
119 /// <li>
120 /// <p>stream.standard.xlarge</p></li>
121 /// <li>
122 /// <p>stream.standard.2xlarge</p></li>
123 /// </ul>
124 pub instance_type: ::std::option::Option<::std::string::String>,
125 /// <p>The fleet type.</p>
126 /// <dl>
127 /// <dt>
128 /// ALWAYS_ON
129 /// </dt>
130 /// <dd>
131 /// <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p>
132 /// </dd>
133 /// <dt>
134 /// ON_DEMAND
135 /// </dt>
136 /// <dd>
137 /// <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p>
138 /// </dd>
139 /// </dl>
140 pub fleet_type: ::std::option::Option<crate::types::FleetType>,
141 /// <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
142 pub compute_capacity: ::std::option::Option<crate::types::ComputeCapacity>,
143 /// <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
144 pub vpc_config: ::std::option::Option<crate::types::VpcConfig>,
145 /// <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
146 /// <p>Specify a value between 600 and 432000.</p>
147 pub max_user_duration_in_seconds: ::std::option::Option<i32>,
148 /// <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>
149 /// <p>Specify a value between 60 and 36000.</p>
150 pub disconnect_timeout_in_seconds: ::std::option::Option<i32>,
151 /// <p>The description to display.</p>
152 pub description: ::std::option::Option<::std::string::String>,
153 /// <p>The fleet name to display.</p>
154 pub display_name: ::std::option::Option<::std::string::String>,
155 /// <p>Enables or disables default internet access for the fleet.</p>
156 pub enable_default_internet_access: ::std::option::Option<bool>,
157 /// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.</p>
158 pub domain_join_info: ::std::option::Option<crate::types::DomainJoinInfo>,
159 /// <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.</p>
160 /// <p>If you do not specify a value, the value is set to an empty string.</p>
161 /// <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:</p>
162 /// <p>_ . : / = + \ - @</p>
163 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
164 pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
165 /// <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p>
166 /// <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.</p><note>
167 /// <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.</p>
168 /// </note>
169 pub idle_disconnect_timeout_in_seconds: ::std::option::Option<i32>,
170 /// <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
171 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
172 pub iam_role_arn: ::std::option::Option<::std::string::String>,
173 /// <p>The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
174 /// <p>The default value is <code>APP</code>.</p>
175 pub stream_view: ::std::option::Option<crate::types::StreamView>,
176 /// <p>The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.</p>
177 pub platform: ::std::option::Option<crate::types::PlatformType>,
178 /// <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.</p>
179 pub max_concurrent_sessions: ::std::option::Option<i32>,
180 /// <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
181 pub usb_device_filter_strings: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
182 /// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
183 pub session_script_s3_location: ::std::option::Option<crate::types::S3Location>,
184 /// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
185 pub max_sessions_per_instance: ::std::option::Option<i32>,
186 /// <p>The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.</p>
187 pub root_volume_config: ::std::option::Option<crate::types::VolumeConfig>,
188}
189impl CreateFleetInput {
190 /// <p>A unique name for the fleet.</p>
191 pub fn name(&self) -> ::std::option::Option<&str> {
192 self.name.as_deref()
193 }
194 /// <p>The name of the image used to create the fleet.</p>
195 pub fn image_name(&self) -> ::std::option::Option<&str> {
196 self.image_name.as_deref()
197 }
198 /// <p>The ARN of the public, private, or shared image to use.</p>
199 pub fn image_arn(&self) -> ::std::option::Option<&str> {
200 self.image_arn.as_deref()
201 }
202 /// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
203 /// <ul>
204 /// <li>
205 /// <p>stream.standard.small</p></li>
206 /// <li>
207 /// <p>stream.standard.medium</p></li>
208 /// <li>
209 /// <p>stream.standard.large</p></li>
210 /// <li>
211 /// <p>stream.standard.xlarge</p></li>
212 /// <li>
213 /// <p>stream.standard.2xlarge</p></li>
214 /// <li>
215 /// <p>stream.compute.large</p></li>
216 /// <li>
217 /// <p>stream.compute.xlarge</p></li>
218 /// <li>
219 /// <p>stream.compute.2xlarge</p></li>
220 /// <li>
221 /// <p>stream.compute.4xlarge</p></li>
222 /// <li>
223 /// <p>stream.compute.8xlarge</p></li>
224 /// <li>
225 /// <p>stream.memory.large</p></li>
226 /// <li>
227 /// <p>stream.memory.xlarge</p></li>
228 /// <li>
229 /// <p>stream.memory.2xlarge</p></li>
230 /// <li>
231 /// <p>stream.memory.4xlarge</p></li>
232 /// <li>
233 /// <p>stream.memory.8xlarge</p></li>
234 /// <li>
235 /// <p>stream.memory.z1d.large</p></li>
236 /// <li>
237 /// <p>stream.memory.z1d.xlarge</p></li>
238 /// <li>
239 /// <p>stream.memory.z1d.2xlarge</p></li>
240 /// <li>
241 /// <p>stream.memory.z1d.3xlarge</p></li>
242 /// <li>
243 /// <p>stream.memory.z1d.6xlarge</p></li>
244 /// <li>
245 /// <p>stream.memory.z1d.12xlarge</p></li>
246 /// <li>
247 /// <p>stream.graphics.g4dn.xlarge</p></li>
248 /// <li>
249 /// <p>stream.graphics.g4dn.2xlarge</p></li>
250 /// <li>
251 /// <p>stream.graphics.g4dn.4xlarge</p></li>
252 /// <li>
253 /// <p>stream.graphics.g4dn.8xlarge</p></li>
254 /// <li>
255 /// <p>stream.graphics.g4dn.12xlarge</p></li>
256 /// <li>
257 /// <p>stream.graphics.g4dn.16xlarge</p></li>
258 /// <li>
259 /// <p>stream.graphics.g5.xlarge</p></li>
260 /// <li>
261 /// <p>stream.graphics.g5.2xlarge</p></li>
262 /// <li>
263 /// <p>stream.graphics.g5.4xlarge</p></li>
264 /// <li>
265 /// <p>stream.graphics.g5.8xlarge</p></li>
266 /// <li>
267 /// <p>stream.graphics.g5.12xlarge</p></li>
268 /// <li>
269 /// <p>stream.graphics.g5.16xlarge</p></li>
270 /// <li>
271 /// <p>stream.graphics.g5.24xlarge</p></li>
272 /// <li>
273 /// <p>stream.graphics.g6.xlarge</p></li>
274 /// <li>
275 /// <p>stream.graphics.g6.2xlarge</p></li>
276 /// <li>
277 /// <p>stream.graphics.g6.4xlarge</p></li>
278 /// <li>
279 /// <p>stream.graphics.g6.8xlarge</p></li>
280 /// <li>
281 /// <p>stream.graphics.g6.16xlarge</p></li>
282 /// <li>
283 /// <p>stream.graphics.g6.12xlarge</p></li>
284 /// <li>
285 /// <p>stream.graphics.g6.24xlarge</p></li>
286 /// <li>
287 /// <p>stream.graphics.gr6.4xlarge</p></li>
288 /// <li>
289 /// <p>stream.graphics.gr6.8xlarge</p></li>
290 /// <li>
291 /// <p>stream.graphics.g6f.large</p></li>
292 /// <li>
293 /// <p>stream.graphics.g6f.xlarge</p></li>
294 /// <li>
295 /// <p>stream.graphics.g6f.2xlarge</p></li>
296 /// <li>
297 /// <p>stream.graphics.g6f.4xlarge</p></li>
298 /// <li>
299 /// <p>stream.graphics.gr6f.4xlarge</p></li>
300 /// </ul>
301 /// <p>The following instance types are available for Elastic fleets:</p>
302 /// <ul>
303 /// <li>
304 /// <p>stream.standard.small</p></li>
305 /// <li>
306 /// <p>stream.standard.medium</p></li>
307 /// <li>
308 /// <p>stream.standard.large</p></li>
309 /// <li>
310 /// <p>stream.standard.xlarge</p></li>
311 /// <li>
312 /// <p>stream.standard.2xlarge</p></li>
313 /// </ul>
314 pub fn instance_type(&self) -> ::std::option::Option<&str> {
315 self.instance_type.as_deref()
316 }
317 /// <p>The fleet type.</p>
318 /// <dl>
319 /// <dt>
320 /// ALWAYS_ON
321 /// </dt>
322 /// <dd>
323 /// <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p>
324 /// </dd>
325 /// <dt>
326 /// ON_DEMAND
327 /// </dt>
328 /// <dd>
329 /// <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p>
330 /// </dd>
331 /// </dl>
332 pub fn fleet_type(&self) -> ::std::option::Option<&crate::types::FleetType> {
333 self.fleet_type.as_ref()
334 }
335 /// <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
336 pub fn compute_capacity(&self) -> ::std::option::Option<&crate::types::ComputeCapacity> {
337 self.compute_capacity.as_ref()
338 }
339 /// <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
340 pub fn vpc_config(&self) -> ::std::option::Option<&crate::types::VpcConfig> {
341 self.vpc_config.as_ref()
342 }
343 /// <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
344 /// <p>Specify a value between 600 and 432000.</p>
345 pub fn max_user_duration_in_seconds(&self) -> ::std::option::Option<i32> {
346 self.max_user_duration_in_seconds
347 }
348 /// <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>
349 /// <p>Specify a value between 60 and 36000.</p>
350 pub fn disconnect_timeout_in_seconds(&self) -> ::std::option::Option<i32> {
351 self.disconnect_timeout_in_seconds
352 }
353 /// <p>The description to display.</p>
354 pub fn description(&self) -> ::std::option::Option<&str> {
355 self.description.as_deref()
356 }
357 /// <p>The fleet name to display.</p>
358 pub fn display_name(&self) -> ::std::option::Option<&str> {
359 self.display_name.as_deref()
360 }
361 /// <p>Enables or disables default internet access for the fleet.</p>
362 pub fn enable_default_internet_access(&self) -> ::std::option::Option<bool> {
363 self.enable_default_internet_access
364 }
365 /// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.</p>
366 pub fn domain_join_info(&self) -> ::std::option::Option<&crate::types::DomainJoinInfo> {
367 self.domain_join_info.as_ref()
368 }
369 /// <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.</p>
370 /// <p>If you do not specify a value, the value is set to an empty string.</p>
371 /// <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:</p>
372 /// <p>_ . : / = + \ - @</p>
373 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
374 pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
375 self.tags.as_ref()
376 }
377 /// <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p>
378 /// <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.</p><note>
379 /// <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.</p>
380 /// </note>
381 pub fn idle_disconnect_timeout_in_seconds(&self) -> ::std::option::Option<i32> {
382 self.idle_disconnect_timeout_in_seconds
383 }
384 /// <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
385 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
386 pub fn iam_role_arn(&self) -> ::std::option::Option<&str> {
387 self.iam_role_arn.as_deref()
388 }
389 /// <p>The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
390 /// <p>The default value is <code>APP</code>.</p>
391 pub fn stream_view(&self) -> ::std::option::Option<&crate::types::StreamView> {
392 self.stream_view.as_ref()
393 }
394 /// <p>The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.</p>
395 pub fn platform(&self) -> ::std::option::Option<&crate::types::PlatformType> {
396 self.platform.as_ref()
397 }
398 /// <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.</p>
399 pub fn max_concurrent_sessions(&self) -> ::std::option::Option<i32> {
400 self.max_concurrent_sessions
401 }
402 /// <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
403 ///
404 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.usb_device_filter_strings.is_none()`.
405 pub fn usb_device_filter_strings(&self) -> &[::std::string::String] {
406 self.usb_device_filter_strings.as_deref().unwrap_or_default()
407 }
408 /// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
409 pub fn session_script_s3_location(&self) -> ::std::option::Option<&crate::types::S3Location> {
410 self.session_script_s3_location.as_ref()
411 }
412 /// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
413 pub fn max_sessions_per_instance(&self) -> ::std::option::Option<i32> {
414 self.max_sessions_per_instance
415 }
416 /// <p>The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.</p>
417 pub fn root_volume_config(&self) -> ::std::option::Option<&crate::types::VolumeConfig> {
418 self.root_volume_config.as_ref()
419 }
420}
421impl CreateFleetInput {
422 /// Creates a new builder-style object to manufacture [`CreateFleetInput`](crate::operation::create_fleet::CreateFleetInput).
423 pub fn builder() -> crate::operation::create_fleet::builders::CreateFleetInputBuilder {
424 crate::operation::create_fleet::builders::CreateFleetInputBuilder::default()
425 }
426}
427
428/// A builder for [`CreateFleetInput`](crate::operation::create_fleet::CreateFleetInput).
429#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
430#[non_exhaustive]
431pub struct CreateFleetInputBuilder {
432 pub(crate) name: ::std::option::Option<::std::string::String>,
433 pub(crate) image_name: ::std::option::Option<::std::string::String>,
434 pub(crate) image_arn: ::std::option::Option<::std::string::String>,
435 pub(crate) instance_type: ::std::option::Option<::std::string::String>,
436 pub(crate) fleet_type: ::std::option::Option<crate::types::FleetType>,
437 pub(crate) compute_capacity: ::std::option::Option<crate::types::ComputeCapacity>,
438 pub(crate) vpc_config: ::std::option::Option<crate::types::VpcConfig>,
439 pub(crate) max_user_duration_in_seconds: ::std::option::Option<i32>,
440 pub(crate) disconnect_timeout_in_seconds: ::std::option::Option<i32>,
441 pub(crate) description: ::std::option::Option<::std::string::String>,
442 pub(crate) display_name: ::std::option::Option<::std::string::String>,
443 pub(crate) enable_default_internet_access: ::std::option::Option<bool>,
444 pub(crate) domain_join_info: ::std::option::Option<crate::types::DomainJoinInfo>,
445 pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
446 pub(crate) idle_disconnect_timeout_in_seconds: ::std::option::Option<i32>,
447 pub(crate) iam_role_arn: ::std::option::Option<::std::string::String>,
448 pub(crate) stream_view: ::std::option::Option<crate::types::StreamView>,
449 pub(crate) platform: ::std::option::Option<crate::types::PlatformType>,
450 pub(crate) max_concurrent_sessions: ::std::option::Option<i32>,
451 pub(crate) usb_device_filter_strings: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
452 pub(crate) session_script_s3_location: ::std::option::Option<crate::types::S3Location>,
453 pub(crate) max_sessions_per_instance: ::std::option::Option<i32>,
454 pub(crate) root_volume_config: ::std::option::Option<crate::types::VolumeConfig>,
455}
456impl CreateFleetInputBuilder {
457 /// <p>A unique name for the fleet.</p>
458 /// This field is required.
459 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
460 self.name = ::std::option::Option::Some(input.into());
461 self
462 }
463 /// <p>A unique name for the fleet.</p>
464 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
465 self.name = input;
466 self
467 }
468 /// <p>A unique name for the fleet.</p>
469 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
470 &self.name
471 }
472 /// <p>The name of the image used to create the fleet.</p>
473 pub fn image_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
474 self.image_name = ::std::option::Option::Some(input.into());
475 self
476 }
477 /// <p>The name of the image used to create the fleet.</p>
478 pub fn set_image_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
479 self.image_name = input;
480 self
481 }
482 /// <p>The name of the image used to create the fleet.</p>
483 pub fn get_image_name(&self) -> &::std::option::Option<::std::string::String> {
484 &self.image_name
485 }
486 /// <p>The ARN of the public, private, or shared image to use.</p>
487 pub fn image_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
488 self.image_arn = ::std::option::Option::Some(input.into());
489 self
490 }
491 /// <p>The ARN of the public, private, or shared image to use.</p>
492 pub fn set_image_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
493 self.image_arn = input;
494 self
495 }
496 /// <p>The ARN of the public, private, or shared image to use.</p>
497 pub fn get_image_arn(&self) -> &::std::option::Option<::std::string::String> {
498 &self.image_arn
499 }
500 /// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
501 /// <ul>
502 /// <li>
503 /// <p>stream.standard.small</p></li>
504 /// <li>
505 /// <p>stream.standard.medium</p></li>
506 /// <li>
507 /// <p>stream.standard.large</p></li>
508 /// <li>
509 /// <p>stream.standard.xlarge</p></li>
510 /// <li>
511 /// <p>stream.standard.2xlarge</p></li>
512 /// <li>
513 /// <p>stream.compute.large</p></li>
514 /// <li>
515 /// <p>stream.compute.xlarge</p></li>
516 /// <li>
517 /// <p>stream.compute.2xlarge</p></li>
518 /// <li>
519 /// <p>stream.compute.4xlarge</p></li>
520 /// <li>
521 /// <p>stream.compute.8xlarge</p></li>
522 /// <li>
523 /// <p>stream.memory.large</p></li>
524 /// <li>
525 /// <p>stream.memory.xlarge</p></li>
526 /// <li>
527 /// <p>stream.memory.2xlarge</p></li>
528 /// <li>
529 /// <p>stream.memory.4xlarge</p></li>
530 /// <li>
531 /// <p>stream.memory.8xlarge</p></li>
532 /// <li>
533 /// <p>stream.memory.z1d.large</p></li>
534 /// <li>
535 /// <p>stream.memory.z1d.xlarge</p></li>
536 /// <li>
537 /// <p>stream.memory.z1d.2xlarge</p></li>
538 /// <li>
539 /// <p>stream.memory.z1d.3xlarge</p></li>
540 /// <li>
541 /// <p>stream.memory.z1d.6xlarge</p></li>
542 /// <li>
543 /// <p>stream.memory.z1d.12xlarge</p></li>
544 /// <li>
545 /// <p>stream.graphics.g4dn.xlarge</p></li>
546 /// <li>
547 /// <p>stream.graphics.g4dn.2xlarge</p></li>
548 /// <li>
549 /// <p>stream.graphics.g4dn.4xlarge</p></li>
550 /// <li>
551 /// <p>stream.graphics.g4dn.8xlarge</p></li>
552 /// <li>
553 /// <p>stream.graphics.g4dn.12xlarge</p></li>
554 /// <li>
555 /// <p>stream.graphics.g4dn.16xlarge</p></li>
556 /// <li>
557 /// <p>stream.graphics.g5.xlarge</p></li>
558 /// <li>
559 /// <p>stream.graphics.g5.2xlarge</p></li>
560 /// <li>
561 /// <p>stream.graphics.g5.4xlarge</p></li>
562 /// <li>
563 /// <p>stream.graphics.g5.8xlarge</p></li>
564 /// <li>
565 /// <p>stream.graphics.g5.12xlarge</p></li>
566 /// <li>
567 /// <p>stream.graphics.g5.16xlarge</p></li>
568 /// <li>
569 /// <p>stream.graphics.g5.24xlarge</p></li>
570 /// <li>
571 /// <p>stream.graphics.g6.xlarge</p></li>
572 /// <li>
573 /// <p>stream.graphics.g6.2xlarge</p></li>
574 /// <li>
575 /// <p>stream.graphics.g6.4xlarge</p></li>
576 /// <li>
577 /// <p>stream.graphics.g6.8xlarge</p></li>
578 /// <li>
579 /// <p>stream.graphics.g6.16xlarge</p></li>
580 /// <li>
581 /// <p>stream.graphics.g6.12xlarge</p></li>
582 /// <li>
583 /// <p>stream.graphics.g6.24xlarge</p></li>
584 /// <li>
585 /// <p>stream.graphics.gr6.4xlarge</p></li>
586 /// <li>
587 /// <p>stream.graphics.gr6.8xlarge</p></li>
588 /// <li>
589 /// <p>stream.graphics.g6f.large</p></li>
590 /// <li>
591 /// <p>stream.graphics.g6f.xlarge</p></li>
592 /// <li>
593 /// <p>stream.graphics.g6f.2xlarge</p></li>
594 /// <li>
595 /// <p>stream.graphics.g6f.4xlarge</p></li>
596 /// <li>
597 /// <p>stream.graphics.gr6f.4xlarge</p></li>
598 /// </ul>
599 /// <p>The following instance types are available for Elastic fleets:</p>
600 /// <ul>
601 /// <li>
602 /// <p>stream.standard.small</p></li>
603 /// <li>
604 /// <p>stream.standard.medium</p></li>
605 /// <li>
606 /// <p>stream.standard.large</p></li>
607 /// <li>
608 /// <p>stream.standard.xlarge</p></li>
609 /// <li>
610 /// <p>stream.standard.2xlarge</p></li>
611 /// </ul>
612 /// This field is required.
613 pub fn instance_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
614 self.instance_type = ::std::option::Option::Some(input.into());
615 self
616 }
617 /// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
618 /// <ul>
619 /// <li>
620 /// <p>stream.standard.small</p></li>
621 /// <li>
622 /// <p>stream.standard.medium</p></li>
623 /// <li>
624 /// <p>stream.standard.large</p></li>
625 /// <li>
626 /// <p>stream.standard.xlarge</p></li>
627 /// <li>
628 /// <p>stream.standard.2xlarge</p></li>
629 /// <li>
630 /// <p>stream.compute.large</p></li>
631 /// <li>
632 /// <p>stream.compute.xlarge</p></li>
633 /// <li>
634 /// <p>stream.compute.2xlarge</p></li>
635 /// <li>
636 /// <p>stream.compute.4xlarge</p></li>
637 /// <li>
638 /// <p>stream.compute.8xlarge</p></li>
639 /// <li>
640 /// <p>stream.memory.large</p></li>
641 /// <li>
642 /// <p>stream.memory.xlarge</p></li>
643 /// <li>
644 /// <p>stream.memory.2xlarge</p></li>
645 /// <li>
646 /// <p>stream.memory.4xlarge</p></li>
647 /// <li>
648 /// <p>stream.memory.8xlarge</p></li>
649 /// <li>
650 /// <p>stream.memory.z1d.large</p></li>
651 /// <li>
652 /// <p>stream.memory.z1d.xlarge</p></li>
653 /// <li>
654 /// <p>stream.memory.z1d.2xlarge</p></li>
655 /// <li>
656 /// <p>stream.memory.z1d.3xlarge</p></li>
657 /// <li>
658 /// <p>stream.memory.z1d.6xlarge</p></li>
659 /// <li>
660 /// <p>stream.memory.z1d.12xlarge</p></li>
661 /// <li>
662 /// <p>stream.graphics.g4dn.xlarge</p></li>
663 /// <li>
664 /// <p>stream.graphics.g4dn.2xlarge</p></li>
665 /// <li>
666 /// <p>stream.graphics.g4dn.4xlarge</p></li>
667 /// <li>
668 /// <p>stream.graphics.g4dn.8xlarge</p></li>
669 /// <li>
670 /// <p>stream.graphics.g4dn.12xlarge</p></li>
671 /// <li>
672 /// <p>stream.graphics.g4dn.16xlarge</p></li>
673 /// <li>
674 /// <p>stream.graphics.g5.xlarge</p></li>
675 /// <li>
676 /// <p>stream.graphics.g5.2xlarge</p></li>
677 /// <li>
678 /// <p>stream.graphics.g5.4xlarge</p></li>
679 /// <li>
680 /// <p>stream.graphics.g5.8xlarge</p></li>
681 /// <li>
682 /// <p>stream.graphics.g5.12xlarge</p></li>
683 /// <li>
684 /// <p>stream.graphics.g5.16xlarge</p></li>
685 /// <li>
686 /// <p>stream.graphics.g5.24xlarge</p></li>
687 /// <li>
688 /// <p>stream.graphics.g6.xlarge</p></li>
689 /// <li>
690 /// <p>stream.graphics.g6.2xlarge</p></li>
691 /// <li>
692 /// <p>stream.graphics.g6.4xlarge</p></li>
693 /// <li>
694 /// <p>stream.graphics.g6.8xlarge</p></li>
695 /// <li>
696 /// <p>stream.graphics.g6.16xlarge</p></li>
697 /// <li>
698 /// <p>stream.graphics.g6.12xlarge</p></li>
699 /// <li>
700 /// <p>stream.graphics.g6.24xlarge</p></li>
701 /// <li>
702 /// <p>stream.graphics.gr6.4xlarge</p></li>
703 /// <li>
704 /// <p>stream.graphics.gr6.8xlarge</p></li>
705 /// <li>
706 /// <p>stream.graphics.g6f.large</p></li>
707 /// <li>
708 /// <p>stream.graphics.g6f.xlarge</p></li>
709 /// <li>
710 /// <p>stream.graphics.g6f.2xlarge</p></li>
711 /// <li>
712 /// <p>stream.graphics.g6f.4xlarge</p></li>
713 /// <li>
714 /// <p>stream.graphics.gr6f.4xlarge</p></li>
715 /// </ul>
716 /// <p>The following instance types are available for Elastic fleets:</p>
717 /// <ul>
718 /// <li>
719 /// <p>stream.standard.small</p></li>
720 /// <li>
721 /// <p>stream.standard.medium</p></li>
722 /// <li>
723 /// <p>stream.standard.large</p></li>
724 /// <li>
725 /// <p>stream.standard.xlarge</p></li>
726 /// <li>
727 /// <p>stream.standard.2xlarge</p></li>
728 /// </ul>
729 pub fn set_instance_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
730 self.instance_type = input;
731 self
732 }
733 /// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
734 /// <ul>
735 /// <li>
736 /// <p>stream.standard.small</p></li>
737 /// <li>
738 /// <p>stream.standard.medium</p></li>
739 /// <li>
740 /// <p>stream.standard.large</p></li>
741 /// <li>
742 /// <p>stream.standard.xlarge</p></li>
743 /// <li>
744 /// <p>stream.standard.2xlarge</p></li>
745 /// <li>
746 /// <p>stream.compute.large</p></li>
747 /// <li>
748 /// <p>stream.compute.xlarge</p></li>
749 /// <li>
750 /// <p>stream.compute.2xlarge</p></li>
751 /// <li>
752 /// <p>stream.compute.4xlarge</p></li>
753 /// <li>
754 /// <p>stream.compute.8xlarge</p></li>
755 /// <li>
756 /// <p>stream.memory.large</p></li>
757 /// <li>
758 /// <p>stream.memory.xlarge</p></li>
759 /// <li>
760 /// <p>stream.memory.2xlarge</p></li>
761 /// <li>
762 /// <p>stream.memory.4xlarge</p></li>
763 /// <li>
764 /// <p>stream.memory.8xlarge</p></li>
765 /// <li>
766 /// <p>stream.memory.z1d.large</p></li>
767 /// <li>
768 /// <p>stream.memory.z1d.xlarge</p></li>
769 /// <li>
770 /// <p>stream.memory.z1d.2xlarge</p></li>
771 /// <li>
772 /// <p>stream.memory.z1d.3xlarge</p></li>
773 /// <li>
774 /// <p>stream.memory.z1d.6xlarge</p></li>
775 /// <li>
776 /// <p>stream.memory.z1d.12xlarge</p></li>
777 /// <li>
778 /// <p>stream.graphics.g4dn.xlarge</p></li>
779 /// <li>
780 /// <p>stream.graphics.g4dn.2xlarge</p></li>
781 /// <li>
782 /// <p>stream.graphics.g4dn.4xlarge</p></li>
783 /// <li>
784 /// <p>stream.graphics.g4dn.8xlarge</p></li>
785 /// <li>
786 /// <p>stream.graphics.g4dn.12xlarge</p></li>
787 /// <li>
788 /// <p>stream.graphics.g4dn.16xlarge</p></li>
789 /// <li>
790 /// <p>stream.graphics.g5.xlarge</p></li>
791 /// <li>
792 /// <p>stream.graphics.g5.2xlarge</p></li>
793 /// <li>
794 /// <p>stream.graphics.g5.4xlarge</p></li>
795 /// <li>
796 /// <p>stream.graphics.g5.8xlarge</p></li>
797 /// <li>
798 /// <p>stream.graphics.g5.12xlarge</p></li>
799 /// <li>
800 /// <p>stream.graphics.g5.16xlarge</p></li>
801 /// <li>
802 /// <p>stream.graphics.g5.24xlarge</p></li>
803 /// <li>
804 /// <p>stream.graphics.g6.xlarge</p></li>
805 /// <li>
806 /// <p>stream.graphics.g6.2xlarge</p></li>
807 /// <li>
808 /// <p>stream.graphics.g6.4xlarge</p></li>
809 /// <li>
810 /// <p>stream.graphics.g6.8xlarge</p></li>
811 /// <li>
812 /// <p>stream.graphics.g6.16xlarge</p></li>
813 /// <li>
814 /// <p>stream.graphics.g6.12xlarge</p></li>
815 /// <li>
816 /// <p>stream.graphics.g6.24xlarge</p></li>
817 /// <li>
818 /// <p>stream.graphics.gr6.4xlarge</p></li>
819 /// <li>
820 /// <p>stream.graphics.gr6.8xlarge</p></li>
821 /// <li>
822 /// <p>stream.graphics.g6f.large</p></li>
823 /// <li>
824 /// <p>stream.graphics.g6f.xlarge</p></li>
825 /// <li>
826 /// <p>stream.graphics.g6f.2xlarge</p></li>
827 /// <li>
828 /// <p>stream.graphics.g6f.4xlarge</p></li>
829 /// <li>
830 /// <p>stream.graphics.gr6f.4xlarge</p></li>
831 /// </ul>
832 /// <p>The following instance types are available for Elastic fleets:</p>
833 /// <ul>
834 /// <li>
835 /// <p>stream.standard.small</p></li>
836 /// <li>
837 /// <p>stream.standard.medium</p></li>
838 /// <li>
839 /// <p>stream.standard.large</p></li>
840 /// <li>
841 /// <p>stream.standard.xlarge</p></li>
842 /// <li>
843 /// <p>stream.standard.2xlarge</p></li>
844 /// </ul>
845 pub fn get_instance_type(&self) -> &::std::option::Option<::std::string::String> {
846 &self.instance_type
847 }
848 /// <p>The fleet type.</p>
849 /// <dl>
850 /// <dt>
851 /// ALWAYS_ON
852 /// </dt>
853 /// <dd>
854 /// <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p>
855 /// </dd>
856 /// <dt>
857 /// ON_DEMAND
858 /// </dt>
859 /// <dd>
860 /// <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p>
861 /// </dd>
862 /// </dl>
863 pub fn fleet_type(mut self, input: crate::types::FleetType) -> Self {
864 self.fleet_type = ::std::option::Option::Some(input);
865 self
866 }
867 /// <p>The fleet type.</p>
868 /// <dl>
869 /// <dt>
870 /// ALWAYS_ON
871 /// </dt>
872 /// <dd>
873 /// <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p>
874 /// </dd>
875 /// <dt>
876 /// ON_DEMAND
877 /// </dt>
878 /// <dd>
879 /// <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p>
880 /// </dd>
881 /// </dl>
882 pub fn set_fleet_type(mut self, input: ::std::option::Option<crate::types::FleetType>) -> Self {
883 self.fleet_type = input;
884 self
885 }
886 /// <p>The fleet type.</p>
887 /// <dl>
888 /// <dt>
889 /// ALWAYS_ON
890 /// </dt>
891 /// <dd>
892 /// <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p>
893 /// </dd>
894 /// <dt>
895 /// ON_DEMAND
896 /// </dt>
897 /// <dd>
898 /// <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p>
899 /// </dd>
900 /// </dl>
901 pub fn get_fleet_type(&self) -> &::std::option::Option<crate::types::FleetType> {
902 &self.fleet_type
903 }
904 /// <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
905 pub fn compute_capacity(mut self, input: crate::types::ComputeCapacity) -> Self {
906 self.compute_capacity = ::std::option::Option::Some(input);
907 self
908 }
909 /// <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
910 pub fn set_compute_capacity(mut self, input: ::std::option::Option<crate::types::ComputeCapacity>) -> Self {
911 self.compute_capacity = input;
912 self
913 }
914 /// <p>The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.</p>
915 pub fn get_compute_capacity(&self) -> &::std::option::Option<crate::types::ComputeCapacity> {
916 &self.compute_capacity
917 }
918 /// <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
919 pub fn vpc_config(mut self, input: crate::types::VpcConfig) -> Self {
920 self.vpc_config = ::std::option::Option::Some(input);
921 self
922 }
923 /// <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
924 pub fn set_vpc_config(mut self, input: ::std::option::Option<crate::types::VpcConfig>) -> Self {
925 self.vpc_config = input;
926 self
927 }
928 /// <p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p>
929 pub fn get_vpc_config(&self) -> &::std::option::Option<crate::types::VpcConfig> {
930 &self.vpc_config
931 }
932 /// <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
933 /// <p>Specify a value between 600 and 432000.</p>
934 pub fn max_user_duration_in_seconds(mut self, input: i32) -> Self {
935 self.max_user_duration_in_seconds = ::std::option::Option::Some(input);
936 self
937 }
938 /// <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
939 /// <p>Specify a value between 600 and 432000.</p>
940 pub fn set_max_user_duration_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
941 self.max_user_duration_in_seconds = input;
942 self
943 }
944 /// <p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>
945 /// <p>Specify a value between 600 and 432000.</p>
946 pub fn get_max_user_duration_in_seconds(&self) -> &::std::option::Option<i32> {
947 &self.max_user_duration_in_seconds
948 }
949 /// <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>
950 /// <p>Specify a value between 60 and 36000.</p>
951 pub fn disconnect_timeout_in_seconds(mut self, input: i32) -> Self {
952 self.disconnect_timeout_in_seconds = ::std::option::Option::Some(input);
953 self
954 }
955 /// <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>
956 /// <p>Specify a value between 60 and 36000.</p>
957 pub fn set_disconnect_timeout_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
958 self.disconnect_timeout_in_seconds = input;
959 self
960 }
961 /// <p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>
962 /// <p>Specify a value between 60 and 36000.</p>
963 pub fn get_disconnect_timeout_in_seconds(&self) -> &::std::option::Option<i32> {
964 &self.disconnect_timeout_in_seconds
965 }
966 /// <p>The description to display.</p>
967 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
968 self.description = ::std::option::Option::Some(input.into());
969 self
970 }
971 /// <p>The description to display.</p>
972 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
973 self.description = input;
974 self
975 }
976 /// <p>The description to display.</p>
977 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
978 &self.description
979 }
980 /// <p>The fleet name to display.</p>
981 pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
982 self.display_name = ::std::option::Option::Some(input.into());
983 self
984 }
985 /// <p>The fleet name to display.</p>
986 pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
987 self.display_name = input;
988 self
989 }
990 /// <p>The fleet name to display.</p>
991 pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
992 &self.display_name
993 }
994 /// <p>Enables or disables default internet access for the fleet.</p>
995 pub fn enable_default_internet_access(mut self, input: bool) -> Self {
996 self.enable_default_internet_access = ::std::option::Option::Some(input);
997 self
998 }
999 /// <p>Enables or disables default internet access for the fleet.</p>
1000 pub fn set_enable_default_internet_access(mut self, input: ::std::option::Option<bool>) -> Self {
1001 self.enable_default_internet_access = input;
1002 self
1003 }
1004 /// <p>Enables or disables default internet access for the fleet.</p>
1005 pub fn get_enable_default_internet_access(&self) -> &::std::option::Option<bool> {
1006 &self.enable_default_internet_access
1007 }
1008 /// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.</p>
1009 pub fn domain_join_info(mut self, input: crate::types::DomainJoinInfo) -> Self {
1010 self.domain_join_info = ::std::option::Option::Some(input);
1011 self
1012 }
1013 /// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.</p>
1014 pub fn set_domain_join_info(mut self, input: ::std::option::Option<crate::types::DomainJoinInfo>) -> Self {
1015 self.domain_join_info = input;
1016 self
1017 }
1018 /// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.</p>
1019 pub fn get_domain_join_info(&self) -> &::std::option::Option<crate::types::DomainJoinInfo> {
1020 &self.domain_join_info
1021 }
1022 /// Adds a key-value pair to `tags`.
1023 ///
1024 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
1025 ///
1026 /// <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.</p>
1027 /// <p>If you do not specify a value, the value is set to an empty string.</p>
1028 /// <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:</p>
1029 /// <p>_ . : / = + \ - @</p>
1030 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
1031 pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
1032 let mut hash_map = self.tags.unwrap_or_default();
1033 hash_map.insert(k.into(), v.into());
1034 self.tags = ::std::option::Option::Some(hash_map);
1035 self
1036 }
1037 /// <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.</p>
1038 /// <p>If you do not specify a value, the value is set to an empty string.</p>
1039 /// <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:</p>
1040 /// <p>_ . : / = + \ - @</p>
1041 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
1042 pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
1043 self.tags = input;
1044 self
1045 }
1046 /// <p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.</p>
1047 /// <p>If you do not specify a value, the value is set to an empty string.</p>
1048 /// <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:</p>
1049 /// <p>_ . : / = + \ - @</p>
1050 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
1051 pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
1052 &self.tags
1053 }
1054 /// <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p>
1055 /// <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.</p><note>
1056 /// <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.</p>
1057 /// </note>
1058 pub fn idle_disconnect_timeout_in_seconds(mut self, input: i32) -> Self {
1059 self.idle_disconnect_timeout_in_seconds = ::std::option::Option::Some(input);
1060 self
1061 }
1062 /// <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p>
1063 /// <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.</p><note>
1064 /// <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.</p>
1065 /// </note>
1066 pub fn set_idle_disconnect_timeout_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
1067 self.idle_disconnect_timeout_in_seconds = input;
1068 self
1069 }
1070 /// <p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p>
1071 /// <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.</p><note>
1072 /// <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.</p>
1073 /// </note>
1074 pub fn get_idle_disconnect_timeout_in_seconds(&self) -> &::std::option::Option<i32> {
1075 &self.idle_disconnect_timeout_in_seconds
1076 }
1077 /// <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
1078 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
1079 pub fn iam_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1080 self.iam_role_arn = ::std::option::Option::Some(input.into());
1081 self
1082 }
1083 /// <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
1084 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
1085 pub fn set_iam_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1086 self.iam_role_arn = input;
1087 self
1088 }
1089 /// <p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p>
1090 /// <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
1091 pub fn get_iam_role_arn(&self) -> &::std::option::Option<::std::string::String> {
1092 &self.iam_role_arn
1093 }
1094 /// <p>The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
1095 /// <p>The default value is <code>APP</code>.</p>
1096 pub fn stream_view(mut self, input: crate::types::StreamView) -> Self {
1097 self.stream_view = ::std::option::Option::Some(input);
1098 self
1099 }
1100 /// <p>The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
1101 /// <p>The default value is <code>APP</code>.</p>
1102 pub fn set_stream_view(mut self, input: ::std::option::Option<crate::types::StreamView>) -> Self {
1103 self.stream_view = input;
1104 self
1105 }
1106 /// <p>The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When <code>APP</code> is specified, only the windows of applications opened by users display. When <code>DESKTOP</code> is specified, the standard desktop that is provided by the operating system displays.</p>
1107 /// <p>The default value is <code>APP</code>.</p>
1108 pub fn get_stream_view(&self) -> &::std::option::Option<crate::types::StreamView> {
1109 &self.stream_view
1110 }
1111 /// <p>The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.</p>
1112 pub fn platform(mut self, input: crate::types::PlatformType) -> Self {
1113 self.platform = ::std::option::Option::Some(input);
1114 self
1115 }
1116 /// <p>The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.</p>
1117 pub fn set_platform(mut self, input: ::std::option::Option<crate::types::PlatformType>) -> Self {
1118 self.platform = input;
1119 self
1120 }
1121 /// <p>The fleet platform. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.</p>
1122 pub fn get_platform(&self) -> &::std::option::Option<crate::types::PlatformType> {
1123 &self.platform
1124 }
1125 /// <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.</p>
1126 pub fn max_concurrent_sessions(mut self, input: i32) -> Self {
1127 self.max_concurrent_sessions = ::std::option::Option::Some(input);
1128 self
1129 }
1130 /// <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.</p>
1131 pub fn set_max_concurrent_sessions(mut self, input: ::std::option::Option<i32>) -> Self {
1132 self.max_concurrent_sessions = input;
1133 self
1134 }
1135 /// <p>The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.</p>
1136 pub fn get_max_concurrent_sessions(&self) -> &::std::option::Option<i32> {
1137 &self.max_concurrent_sessions
1138 }
1139 /// Appends an item to `usb_device_filter_strings`.
1140 ///
1141 /// To override the contents of this collection use [`set_usb_device_filter_strings`](Self::set_usb_device_filter_strings).
1142 ///
1143 /// <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
1144 pub fn usb_device_filter_strings(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1145 let mut v = self.usb_device_filter_strings.unwrap_or_default();
1146 v.push(input.into());
1147 self.usb_device_filter_strings = ::std::option::Option::Some(v);
1148 self
1149 }
1150 /// <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
1151 pub fn set_usb_device_filter_strings(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
1152 self.usb_device_filter_strings = input;
1153 self
1154 }
1155 /// <p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p>
1156 pub fn get_usb_device_filter_strings(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
1157 &self.usb_device_filter_strings
1158 }
1159 /// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
1160 pub fn session_script_s3_location(mut self, input: crate::types::S3Location) -> Self {
1161 self.session_script_s3_location = ::std::option::Option::Some(input);
1162 self
1163 }
1164 /// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
1165 pub fn set_session_script_s3_location(mut self, input: ::std::option::Option<crate::types::S3Location>) -> Self {
1166 self.session_script_s3_location = input;
1167 self
1168 }
1169 /// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
1170 pub fn get_session_script_s3_location(&self) -> &::std::option::Option<crate::types::S3Location> {
1171 &self.session_script_s3_location
1172 }
1173 /// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
1174 pub fn max_sessions_per_instance(mut self, input: i32) -> Self {
1175 self.max_sessions_per_instance = ::std::option::Option::Some(input);
1176 self
1177 }
1178 /// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
1179 pub fn set_max_sessions_per_instance(mut self, input: ::std::option::Option<i32>) -> Self {
1180 self.max_sessions_per_instance = input;
1181 self
1182 }
1183 /// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
1184 pub fn get_max_sessions_per_instance(&self) -> &::std::option::Option<i32> {
1185 &self.max_sessions_per_instance
1186 }
1187 /// <p>The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.</p>
1188 pub fn root_volume_config(mut self, input: crate::types::VolumeConfig) -> Self {
1189 self.root_volume_config = ::std::option::Option::Some(input);
1190 self
1191 }
1192 /// <p>The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.</p>
1193 pub fn set_root_volume_config(mut self, input: ::std::option::Option<crate::types::VolumeConfig>) -> Self {
1194 self.root_volume_config = input;
1195 self
1196 }
1197 /// <p>The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.</p>
1198 pub fn get_root_volume_config(&self) -> &::std::option::Option<crate::types::VolumeConfig> {
1199 &self.root_volume_config
1200 }
1201 /// Consumes the builder and constructs a [`CreateFleetInput`](crate::operation::create_fleet::CreateFleetInput).
1202 pub fn build(self) -> ::std::result::Result<crate::operation::create_fleet::CreateFleetInput, ::aws_smithy_types::error::operation::BuildError> {
1203 ::std::result::Result::Ok(crate::operation::create_fleet::CreateFleetInput {
1204 name: self.name,
1205 image_name: self.image_name,
1206 image_arn: self.image_arn,
1207 instance_type: self.instance_type,
1208 fleet_type: self.fleet_type,
1209 compute_capacity: self.compute_capacity,
1210 vpc_config: self.vpc_config,
1211 max_user_duration_in_seconds: self.max_user_duration_in_seconds,
1212 disconnect_timeout_in_seconds: self.disconnect_timeout_in_seconds,
1213 description: self.description,
1214 display_name: self.display_name,
1215 enable_default_internet_access: self.enable_default_internet_access,
1216 domain_join_info: self.domain_join_info,
1217 tags: self.tags,
1218 idle_disconnect_timeout_in_seconds: self.idle_disconnect_timeout_in_seconds,
1219 iam_role_arn: self.iam_role_arn,
1220 stream_view: self.stream_view,
1221 platform: self.platform,
1222 max_concurrent_sessions: self.max_concurrent_sessions,
1223 usb_device_filter_strings: self.usb_device_filter_strings,
1224 session_script_s3_location: self.session_script_s3_location,
1225 max_sessions_per_instance: self.max_sessions_per_instance,
1226 root_volume_config: self.root_volume_config,
1227 })
1228 }
1229}