1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ImportWorkspaceImageInput {
/// <p>The identifier of the EC2 image.</p>
pub ec2_image_id: ::std::option::Option<::std::string::String>,
/// <p>The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p>
/// <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note>
/// <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
/// </note>
pub ingestion_process: ::std::option::Option<crate::types::WorkspaceImageIngestionProcess>,
/// <p>The name of the WorkSpace image.</p>
pub image_name: ::std::option::Option<::std::string::String>,
/// <p>The description of the WorkSpace image.</p>
pub image_description: ::std::option::Option<::std::string::String>,
/// <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p> <note>
/// <ul>
/// <li> <p>Although this parameter is an array, only one item is allowed at this time.</p> </li>
/// <li> <p>Windows 11 only supports <code>Microsoft_Office_2019</code>.</p> </li>
/// </ul>
/// </note>
pub applications: ::std::option::Option<::std::vec::Vec<crate::types::Application>>,
}
impl ImportWorkspaceImageInput {
/// <p>The identifier of the EC2 image.</p>
pub fn ec2_image_id(&self) -> ::std::option::Option<&str> {
self.ec2_image_id.as_deref()
}
/// <p>The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p>
/// <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note>
/// <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
/// </note>
pub fn ingestion_process(&self) -> ::std::option::Option<&crate::types::WorkspaceImageIngestionProcess> {
self.ingestion_process.as_ref()
}
/// <p>The name of the WorkSpace image.</p>
pub fn image_name(&self) -> ::std::option::Option<&str> {
self.image_name.as_deref()
}
/// <p>The description of the WorkSpace image.</p>
pub fn image_description(&self) -> ::std::option::Option<&str> {
self.image_description.as_deref()
}
/// <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p> <note>
/// <ul>
/// <li> <p>Although this parameter is an array, only one item is allowed at this time.</p> </li>
/// <li> <p>Windows 11 only supports <code>Microsoft_Office_2019</code>.</p> </li>
/// </ul>
/// </note>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.applications.is_none()`.
pub fn applications(&self) -> &[crate::types::Application] {
self.applications.as_deref().unwrap_or_default()
}
}
impl ImportWorkspaceImageInput {
/// Creates a new builder-style object to manufacture [`ImportWorkspaceImageInput`](crate::operation::import_workspace_image::ImportWorkspaceImageInput).
pub fn builder() -> crate::operation::import_workspace_image::builders::ImportWorkspaceImageInputBuilder {
crate::operation::import_workspace_image::builders::ImportWorkspaceImageInputBuilder::default()
}
}
/// A builder for [`ImportWorkspaceImageInput`](crate::operation::import_workspace_image::ImportWorkspaceImageInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct ImportWorkspaceImageInputBuilder {
pub(crate) ec2_image_id: ::std::option::Option<::std::string::String>,
pub(crate) ingestion_process: ::std::option::Option<crate::types::WorkspaceImageIngestionProcess>,
pub(crate) image_name: ::std::option::Option<::std::string::String>,
pub(crate) image_description: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) applications: ::std::option::Option<::std::vec::Vec<crate::types::Application>>,
}
impl ImportWorkspaceImageInputBuilder {
/// <p>The identifier of the EC2 image.</p>
/// This field is required.
pub fn ec2_image_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.ec2_image_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the EC2 image.</p>
pub fn set_ec2_image_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.ec2_image_id = input;
self
}
/// <p>The identifier of the EC2 image.</p>
pub fn get_ec2_image_id(&self) -> &::std::option::Option<::std::string::String> {
&self.ec2_image_id
}
/// <p>The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p>
/// <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note>
/// <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
/// </note>
/// This field is required.
pub fn ingestion_process(mut self, input: crate::types::WorkspaceImageIngestionProcess) -> Self {
self.ingestion_process = ::std::option::Option::Some(input);
self
}
/// <p>The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p>
/// <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note>
/// <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
/// </note>
pub fn set_ingestion_process(mut self, input: ::std::option::Option<crate::types::WorkspaceImageIngestionProcess>) -> Self {
self.ingestion_process = input;
self
}
/// <p>The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p>
/// <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note>
/// <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
/// </note>
pub fn get_ingestion_process(&self) -> &::std::option::Option<crate::types::WorkspaceImageIngestionProcess> {
&self.ingestion_process
}
/// <p>The name of the WorkSpace image.</p>
/// This field is required.
pub fn image_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.image_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the WorkSpace image.</p>
pub fn set_image_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.image_name = input;
self
}
/// <p>The name of the WorkSpace image.</p>
pub fn get_image_name(&self) -> &::std::option::Option<::std::string::String> {
&self.image_name
}
/// <p>The description of the WorkSpace image.</p>
/// This field is required.
pub fn image_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.image_description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description of the WorkSpace image.</p>
pub fn set_image_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.image_description = input;
self
}
/// <p>The description of the WorkSpace image.</p>
pub fn get_image_description(&self) -> &::std::option::Option<::std::string::String> {
&self.image_description
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Appends an item to `applications`.
///
/// To override the contents of this collection use [`set_applications`](Self::set_applications).
///
/// <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p> <note>
/// <ul>
/// <li> <p>Although this parameter is an array, only one item is allowed at this time.</p> </li>
/// <li> <p>Windows 11 only supports <code>Microsoft_Office_2019</code>.</p> </li>
/// </ul>
/// </note>
pub fn applications(mut self, input: crate::types::Application) -> Self {
let mut v = self.applications.unwrap_or_default();
v.push(input);
self.applications = ::std::option::Option::Some(v);
self
}
/// <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p> <note>
/// <ul>
/// <li> <p>Although this parameter is an array, only one item is allowed at this time.</p> </li>
/// <li> <p>Windows 11 only supports <code>Microsoft_Office_2019</code>.</p> </li>
/// </ul>
/// </note>
pub fn set_applications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Application>>) -> Self {
self.applications = input;
self
}
/// <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p> <note>
/// <ul>
/// <li> <p>Although this parameter is an array, only one item is allowed at this time.</p> </li>
/// <li> <p>Windows 11 only supports <code>Microsoft_Office_2019</code>.</p> </li>
/// </ul>
/// </note>
pub fn get_applications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Application>> {
&self.applications
}
/// Consumes the builder and constructs a [`ImportWorkspaceImageInput`](crate::operation::import_workspace_image::ImportWorkspaceImageInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::import_workspace_image::ImportWorkspaceImageInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::import_workspace_image::ImportWorkspaceImageInput {
ec2_image_id: self.ec2_image_id,
ingestion_process: self.ingestion_process,
image_name: self.image_name,
image_description: self.image_description,
tags: self.tags,
applications: self.applications,
})
}
}