aws_sdk_workspacesthinclient/client/create_environment.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateEnvironment`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`name(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_name):<br>required: **false**<br><p>The name for the environment.</p><br>
7 /// - [`desktop_arn(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::desktop_arn) / [`set_desktop_arn(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_desktop_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.</p><br>
8 /// - [`desktop_endpoint(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::desktop_endpoint) / [`set_desktop_endpoint(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_desktop_endpoint):<br>required: **false**<br><p>The URL for the identity provider login (only for environments that use AppStream 2.0).</p><br>
9 /// - [`software_set_update_schedule(SoftwareSetUpdateSchedule)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::software_set_update_schedule) / [`set_software_set_update_schedule(Option<SoftwareSetUpdateSchedule>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_software_set_update_schedule):<br>required: **false**<br><p>An option to define if software updates should be applied within a maintenance window.</p><br>
10 /// - [`maintenance_window(MaintenanceWindow)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::maintenance_window) / [`set_maintenance_window(Option<MaintenanceWindow>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_maintenance_window):<br>required: **false**<br><p>A specification for a time window to apply software updates.</p><br>
11 /// - [`software_set_update_mode(SoftwareSetUpdateMode)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::software_set_update_mode) / [`set_software_set_update_mode(Option<SoftwareSetUpdateMode>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_software_set_update_mode):<br>required: **false**<br><p>An option to define which software updates to apply.</p><br>
12 /// - [`desired_software_set_id(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::desired_software_set_id) / [`set_desired_software_set_id(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_desired_software_set_id):<br>required: **false**<br><p>The ID of the software set to apply.</p><br>
13 /// - [`kms_key_arn(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_kms_key_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.</p><br>
14 /// - [`client_token(impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_client_token):<br>required: **false**<br><p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p><br>
15 /// - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_tags):<br>required: **false**<br><p>A map of the key-value pairs of the tag or tags to assign to the resource.</p><br>
16 /// - [`device_creation_tags(impl Into<String>, impl Into<String>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::device_creation_tags) / [`set_device_creation_tags(Option<HashMap::<String, String>>)`](crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::set_device_creation_tags):<br>required: **false**<br><p>A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.</p><br>
17 /// - On success, responds with [`CreateEnvironmentOutput`](crate::operation::create_environment::CreateEnvironmentOutput) with field(s):
18 /// - [`environment(Option<EnvironmentSummary>)`](crate::operation::create_environment::CreateEnvironmentOutput::environment): <p>Describes an environment.</p>
19 /// - On failure, responds with [`SdkError<CreateEnvironmentError>`](crate::operation::create_environment::CreateEnvironmentError)
20 pub fn create_environment(&self) -> crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder {
21 crate::operation::create_environment::builders::CreateEnvironmentFluentBuilder::new(self.handle.clone())
22 }
23}