aws_sdk_appstream/operation/create_imported_image/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_imported_image::_create_imported_image_output::CreateImportedImageOutputBuilder;
3
4pub use crate::operation::create_imported_image::_create_imported_image_input::CreateImportedImageInputBuilder;
5
6impl crate::operation::create_imported_image::builders::CreateImportedImageInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_imported_image::CreateImportedImageOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_imported_image::CreateImportedImageError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_imported_image();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateImportedImage`.
24///
25/// <p>Creates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications images that support additional instance types beyond the standard stream.* instances.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateImportedImageFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_imported_image::builders::CreateImportedImageInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_imported_image::CreateImportedImageOutput,
35        crate::operation::create_imported_image::CreateImportedImageError,
36    > for CreateImportedImageFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_imported_image::CreateImportedImageOutput,
44            crate::operation::create_imported_image::CreateImportedImageError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateImportedImageFluentBuilder {
51    /// Creates a new `CreateImportedImageFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateImportedImage as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_imported_image::builders::CreateImportedImageInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_imported_image::CreateImportedImageOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_imported_image::CreateImportedImageError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_imported_image::CreateImportedImage::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_imported_image::CreateImportedImage::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_imported_image::CreateImportedImageOutput,
97        crate::operation::create_imported_image::CreateImportedImageError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.</p>
112    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.name(input.into());
114        self
115    }
116    /// <p>A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.</p>
117    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_name(input);
119        self
120    }
121    /// <p>A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.</p>
122    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_name()
124    }
125    /// <p>The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.</p>
126    pub fn source_ami_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.source_ami_id(input.into());
128        self
129    }
130    /// <p>The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.</p>
131    pub fn set_source_ami_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_source_ami_id(input);
133        self
134    }
135    /// <p>The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.</p>
136    pub fn get_source_ami_id(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_source_ami_id()
138    }
139    /// <p>The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.</p>
140    pub fn iam_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.iam_role_arn(input.into());
142        self
143    }
144    /// <p>The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.</p>
145    pub fn set_iam_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_iam_role_arn(input);
147        self
148    }
149    /// <p>The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.</p>
150    pub fn get_iam_role_arn(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_iam_role_arn()
152    }
153    /// <p>An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.</p>
154    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.description(input.into());
156        self
157    }
158    /// <p>An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.</p>
159    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_description(input);
161        self
162    }
163    /// <p>An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.</p>
164    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_description()
166    }
167    /// <p>An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.</p>
168    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.display_name(input.into());
170        self
171    }
172    /// <p>An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.</p>
173    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174        self.inner = self.inner.set_display_name(input);
175        self
176    }
177    /// <p>An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.</p>
178    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
179        self.inner.get_display_name()
180    }
181    ///
182    /// Adds a key-value pair to `Tags`.
183    ///
184    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
185    ///
186    /// <p>The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.</p>
187    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
188        self.inner = self.inner.tags(k.into(), v.into());
189        self
190    }
191    /// <p>The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.</p>
192    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
193        self.inner = self.inner.set_tags(input);
194        self
195    }
196    /// <p>The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.</p>
197    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
198        self.inner.get_tags()
199    }
200    /// <p>Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.</p>
201    pub fn runtime_validation_config(mut self, input: crate::types::RuntimeValidationConfig) -> Self {
202        self.inner = self.inner.runtime_validation_config(input);
203        self
204    }
205    /// <p>Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.</p>
206    pub fn set_runtime_validation_config(mut self, input: ::std::option::Option<crate::types::RuntimeValidationConfig>) -> Self {
207        self.inner = self.inner.set_runtime_validation_config(input);
208        self
209    }
210    /// <p>Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.</p>
211    pub fn get_runtime_validation_config(&self) -> &::std::option::Option<crate::types::RuntimeValidationConfig> {
212        self.inner.get_runtime_validation_config()
213    }
214    /// <p>The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.</p>
215    pub fn agent_software_version(mut self, input: crate::types::AgentSoftwareVersion) -> Self {
216        self.inner = self.inner.agent_software_version(input);
217        self
218    }
219    /// <p>The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.</p>
220    pub fn set_agent_software_version(mut self, input: ::std::option::Option<crate::types::AgentSoftwareVersion>) -> Self {
221        self.inner = self.inner.set_agent_software_version(input);
222        self
223    }
224    /// <p>The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.</p>
225    pub fn get_agent_software_version(&self) -> &::std::option::Option<crate::types::AgentSoftwareVersion> {
226        self.inner.get_agent_software_version()
227    }
228    ///
229    /// Appends an item to `AppCatalogConfig`.
230    ///
231    /// To override the contents of this collection use [`set_app_catalog_config`](Self::set_app_catalog_config).
232    ///
233    /// <p>Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.</p>
234    pub fn app_catalog_config(mut self, input: crate::types::ApplicationConfig) -> Self {
235        self.inner = self.inner.app_catalog_config(input);
236        self
237    }
238    /// <p>Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.</p>
239    pub fn set_app_catalog_config(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ApplicationConfig>>) -> Self {
240        self.inner = self.inner.set_app_catalog_config(input);
241        self
242    }
243    /// <p>Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.</p>
244    pub fn get_app_catalog_config(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ApplicationConfig>> {
245        self.inner.get_app_catalog_config()
246    }
247    /// <p>When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.</p>
248    pub fn dry_run(mut self, input: bool) -> Self {
249        self.inner = self.inner.dry_run(input);
250        self
251    }
252    /// <p>When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.</p>
253    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
254        self.inner = self.inner.set_dry_run(input);
255        self
256    }
257    /// <p>When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.</p>
258    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
259        self.inner.get_dry_run()
260    }
261}
aws_sdk_appstream/operation/create_imported_image/builders.rs

aws_sdk_appstream/operation/create_imported_image/
builders.rs
