// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Describes a fleet.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Fleet {
/// <p>The Amazon Resource Name (ARN) for the fleet.</p>
pub arn: ::std::option::Option<::std::string::String>,
/// <p>The name of the fleet.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The fleet name to display.</p>
pub display_name: ::std::option::Option<::std::string::String>,
/// <p>The description to display.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The name of the image used to create the fleet.</p>
pub image_name: ::std::option::Option<::std::string::String>,
/// <p>The ARN for the public, private, or shared image.</p>
pub image_arn: ::std::option::Option<::std::string::String>,
/// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
/// <ul>
/// <li>
/// <p>stream.standard.small</p></li>
/// <li>
/// <p>stream.standard.medium</p></li>
/// <li>
/// <p>stream.standard.large</p></li>
/// <li>
/// <p>stream.compute.large</p></li>
/// <li>
/// <p>stream.compute.xlarge</p></li>
/// <li>
/// <p>stream.compute.2xlarge</p></li>
/// <li>
/// <p>stream.compute.4xlarge</p></li>
/// <li>
/// <p>stream.compute.8xlarge</p></li>
/// <li>
/// <p>stream.memory.large</p></li>
/// <li>
/// <p>stream.memory.xlarge</p></li>
/// <li>
/// <p>stream.memory.2xlarge</p></li>
/// <li>
/// <p>stream.memory.4xlarge</p></li>
/// <li>
/// <p>stream.memory.8xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.large</p></li>
/// <li>
/// <p>stream.memory.z1d.xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.2xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.3xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.6xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.large</p></li>
/// <li>
/// <p>stream.graphics.g6f.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6f.4xlarge</p></li>
/// </ul>
pub instance_type: ::std::option::Option<::std::string::String>,
/// <p>The fleet type.</p>
/// <dl>
/// <dt>
/// ALWAYS_ON
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// ON_DEMAND
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// </dl>
pub fleet_type: ::std::option::Option<crate::types::FleetType>,
/// <p>The capacity status for the fleet.</p>
pub compute_capacity_status: ::std::option::Option<crate::types::ComputeCapacityStatus>,
/// <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>
/// <p>Specify a value between 600 and 360000.</p>
pub max_user_duration_in_seconds: ::std::option::Option<i32>,
/// <p>The amount of time that a streaming session remains active after users disconnect. If they 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>
/// <p>Specify a value between 60 and 36000.</p>
pub disconnect_timeout_in_seconds: ::std::option::Option<i32>,
/// <p>The current state for the fleet.</p>
pub state: ::std::option::Option<crate::types::FleetState>,
/// <p>The VPC configuration for the fleet.</p>
pub vpc_config: ::std::option::Option<crate::types::VpcConfig>,
/// <p>The time the fleet was created.</p>
pub created_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The fleet errors.</p>
pub fleet_errors: ::std::option::Option<::std::vec::Vec<crate::types::FleetError>>,
/// <p>Indicates whether default internet access is enabled for the fleet.</p>
pub enable_default_internet_access: ::std::option::Option<bool>,
/// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.</p>
pub domain_join_info: ::std::option::Option<crate::types::DomainJoinInfo>,
/// <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 users 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>
/// <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>
/// <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>
/// </note>
pub idle_disconnect_timeout_in_seconds: ::std::option::Option<i32>,
/// <p>The ARN of the IAM role that is applied to the fleet. To assume a role, the 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>
/// <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>
pub iam_role_arn: ::std::option::Option<::std::string::String>,
/// <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>
/// <p>The default value is <code>APP</code>.</p>
pub stream_view: ::std::option::Option<crate::types::StreamView>,
/// <p>The platform of the fleet.</p>
pub platform: ::std::option::Option<crate::types::PlatformType>,
/// <p>The maximum number of concurrent sessions for the fleet.</p>
pub max_concurrent_sessions: ::std::option::Option<i32>,
/// <p>The USB device filter strings associated with the fleet.</p>
pub usb_device_filter_strings: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
pub session_script_s3_location: ::std::option::Option<crate::types::S3Location>,
/// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
pub max_sessions_per_instance: ::std::option::Option<i32>,
/// <p>The current configuration of the root volume for fleet instances, including the storage size in GB.</p>
pub root_volume_config: ::std::option::Option<crate::types::VolumeConfig>,
/// <p>Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.</p>
pub disable_imdsv1: ::std::option::Option<bool>,
}
impl Fleet {
/// <p>The Amazon Resource Name (ARN) for the fleet.</p>
pub fn arn(&self) -> ::std::option::Option<&str> {
self.arn.as_deref()
}
/// <p>The name of the fleet.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The fleet name to display.</p>
pub fn display_name(&self) -> ::std::option::Option<&str> {
self.display_name.as_deref()
}
/// <p>The description to display.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The name of the image used to create the fleet.</p>
pub fn image_name(&self) -> ::std::option::Option<&str> {
self.image_name.as_deref()
}
/// <p>The ARN for the public, private, or shared image.</p>
pub fn image_arn(&self) -> ::std::option::Option<&str> {
self.image_arn.as_deref()
}
/// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
/// <ul>
/// <li>
/// <p>stream.standard.small</p></li>
/// <li>
/// <p>stream.standard.medium</p></li>
/// <li>
/// <p>stream.standard.large</p></li>
/// <li>
/// <p>stream.compute.large</p></li>
/// <li>
/// <p>stream.compute.xlarge</p></li>
/// <li>
/// <p>stream.compute.2xlarge</p></li>
/// <li>
/// <p>stream.compute.4xlarge</p></li>
/// <li>
/// <p>stream.compute.8xlarge</p></li>
/// <li>
/// <p>stream.memory.large</p></li>
/// <li>
/// <p>stream.memory.xlarge</p></li>
/// <li>
/// <p>stream.memory.2xlarge</p></li>
/// <li>
/// <p>stream.memory.4xlarge</p></li>
/// <li>
/// <p>stream.memory.8xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.large</p></li>
/// <li>
/// <p>stream.memory.z1d.xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.2xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.3xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.6xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.large</p></li>
/// <li>
/// <p>stream.graphics.g6f.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6f.4xlarge</p></li>
/// </ul>
pub fn instance_type(&self) -> ::std::option::Option<&str> {
self.instance_type.as_deref()
}
/// <p>The fleet type.</p>
/// <dl>
/// <dt>
/// ALWAYS_ON
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// ON_DEMAND
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// </dl>
pub fn fleet_type(&self) -> ::std::option::Option<&crate::types::FleetType> {
self.fleet_type.as_ref()
}
/// <p>The capacity status for the fleet.</p>
pub fn compute_capacity_status(&self) -> ::std::option::Option<&crate::types::ComputeCapacityStatus> {
self.compute_capacity_status.as_ref()
}
/// <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>
/// <p>Specify a value between 600 and 360000.</p>
pub fn max_user_duration_in_seconds(&self) -> ::std::option::Option<i32> {
self.max_user_duration_in_seconds
}
/// <p>The amount of time that a streaming session remains active after users disconnect. If they 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>
/// <p>Specify a value between 60 and 36000.</p>
pub fn disconnect_timeout_in_seconds(&self) -> ::std::option::Option<i32> {
self.disconnect_timeout_in_seconds
}
/// <p>The current state for the fleet.</p>
pub fn state(&self) -> ::std::option::Option<&crate::types::FleetState> {
self.state.as_ref()
}
/// <p>The VPC configuration for the fleet.</p>
pub fn vpc_config(&self) -> ::std::option::Option<&crate::types::VpcConfig> {
self.vpc_config.as_ref()
}
/// <p>The time the fleet was created.</p>
pub fn created_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.created_time.as_ref()
}
/// <p>The fleet errors.</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 `.fleet_errors.is_none()`.
pub fn fleet_errors(&self) -> &[crate::types::FleetError] {
self.fleet_errors.as_deref().unwrap_or_default()
}
/// <p>Indicates whether default internet access is enabled for the fleet.</p>
pub fn enable_default_internet_access(&self) -> ::std::option::Option<bool> {
self.enable_default_internet_access
}
/// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.</p>
pub fn domain_join_info(&self) -> ::std::option::Option<&crate::types::DomainJoinInfo> {
self.domain_join_info.as_ref()
}
/// <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 users 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>
/// <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>
/// <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>
/// </note>
pub fn idle_disconnect_timeout_in_seconds(&self) -> ::std::option::Option<i32> {
self.idle_disconnect_timeout_in_seconds
}
/// <p>The ARN of the IAM role that is applied to the fleet. To assume a role, the 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>
/// <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>
pub fn iam_role_arn(&self) -> ::std::option::Option<&str> {
self.iam_role_arn.as_deref()
}
/// <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>
/// <p>The default value is <code>APP</code>.</p>
pub fn stream_view(&self) -> ::std::option::Option<&crate::types::StreamView> {
self.stream_view.as_ref()
}
/// <p>The platform of the fleet.</p>
pub fn platform(&self) -> ::std::option::Option<&crate::types::PlatformType> {
self.platform.as_ref()
}
/// <p>The maximum number of concurrent sessions for the fleet.</p>
pub fn max_concurrent_sessions(&self) -> ::std::option::Option<i32> {
self.max_concurrent_sessions
}
/// <p>The USB device filter strings associated with the fleet.</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 `.usb_device_filter_strings.is_none()`.
pub fn usb_device_filter_strings(&self) -> &[::std::string::String] {
self.usb_device_filter_strings.as_deref().unwrap_or_default()
}
/// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
pub fn session_script_s3_location(&self) -> ::std::option::Option<&crate::types::S3Location> {
self.session_script_s3_location.as_ref()
}
/// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
pub fn max_sessions_per_instance(&self) -> ::std::option::Option<i32> {
self.max_sessions_per_instance
}
/// <p>The current configuration of the root volume for fleet instances, including the storage size in GB.</p>
pub fn root_volume_config(&self) -> ::std::option::Option<&crate::types::VolumeConfig> {
self.root_volume_config.as_ref()
}
/// <p>Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.</p>
pub fn disable_imdsv1(&self) -> ::std::option::Option<bool> {
self.disable_imdsv1
}
}
impl Fleet {
/// Creates a new builder-style object to manufacture [`Fleet`](crate::types::Fleet).
pub fn builder() -> crate::types::builders::FleetBuilder {
crate::types::builders::FleetBuilder::default()
}
}
/// A builder for [`Fleet`](crate::types::Fleet).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct FleetBuilder {
pub(crate) arn: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) display_name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) image_name: ::std::option::Option<::std::string::String>,
pub(crate) image_arn: ::std::option::Option<::std::string::String>,
pub(crate) instance_type: ::std::option::Option<::std::string::String>,
pub(crate) fleet_type: ::std::option::Option<crate::types::FleetType>,
pub(crate) compute_capacity_status: ::std::option::Option<crate::types::ComputeCapacityStatus>,
pub(crate) max_user_duration_in_seconds: ::std::option::Option<i32>,
pub(crate) disconnect_timeout_in_seconds: ::std::option::Option<i32>,
pub(crate) state: ::std::option::Option<crate::types::FleetState>,
pub(crate) vpc_config: ::std::option::Option<crate::types::VpcConfig>,
pub(crate) created_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) fleet_errors: ::std::option::Option<::std::vec::Vec<crate::types::FleetError>>,
pub(crate) enable_default_internet_access: ::std::option::Option<bool>,
pub(crate) domain_join_info: ::std::option::Option<crate::types::DomainJoinInfo>,
pub(crate) idle_disconnect_timeout_in_seconds: ::std::option::Option<i32>,
pub(crate) iam_role_arn: ::std::option::Option<::std::string::String>,
pub(crate) stream_view: ::std::option::Option<crate::types::StreamView>,
pub(crate) platform: ::std::option::Option<crate::types::PlatformType>,
pub(crate) max_concurrent_sessions: ::std::option::Option<i32>,
pub(crate) usb_device_filter_strings: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) session_script_s3_location: ::std::option::Option<crate::types::S3Location>,
pub(crate) max_sessions_per_instance: ::std::option::Option<i32>,
pub(crate) root_volume_config: ::std::option::Option<crate::types::VolumeConfig>,
pub(crate) disable_imdsv1: ::std::option::Option<bool>,
}
impl FleetBuilder {
/// <p>The Amazon Resource Name (ARN) for the fleet.</p>
/// This field is required.
pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) for the fleet.</p>
pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) for the fleet.</p>
pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.arn
}
/// <p>The name of the fleet.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the fleet.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the fleet.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The fleet name to display.</p>
pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.display_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The fleet name to display.</p>
pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.display_name = input;
self
}
/// <p>The fleet name to display.</p>
pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
&self.display_name
}
/// <p>The description to display.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description to display.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description to display.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The name of the image used to create the fleet.</p>
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 image used to create the fleet.</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 image used to create the fleet.</p>
pub fn get_image_name(&self) -> &::std::option::Option<::std::string::String> {
&self.image_name
}
/// <p>The ARN for the public, private, or shared image.</p>
pub fn image_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.image_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN for the public, private, or shared image.</p>
pub fn set_image_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.image_arn = input;
self
}
/// <p>The ARN for the public, private, or shared image.</p>
pub fn get_image_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.image_arn
}
/// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
/// <ul>
/// <li>
/// <p>stream.standard.small</p></li>
/// <li>
/// <p>stream.standard.medium</p></li>
/// <li>
/// <p>stream.standard.large</p></li>
/// <li>
/// <p>stream.compute.large</p></li>
/// <li>
/// <p>stream.compute.xlarge</p></li>
/// <li>
/// <p>stream.compute.2xlarge</p></li>
/// <li>
/// <p>stream.compute.4xlarge</p></li>
/// <li>
/// <p>stream.compute.8xlarge</p></li>
/// <li>
/// <p>stream.memory.large</p></li>
/// <li>
/// <p>stream.memory.xlarge</p></li>
/// <li>
/// <p>stream.memory.2xlarge</p></li>
/// <li>
/// <p>stream.memory.4xlarge</p></li>
/// <li>
/// <p>stream.memory.8xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.large</p></li>
/// <li>
/// <p>stream.memory.z1d.xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.2xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.3xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.6xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.large</p></li>
/// <li>
/// <p>stream.graphics.g6f.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6f.4xlarge</p></li>
/// </ul>
/// This field is required.
pub fn instance_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.instance_type = ::std::option::Option::Some(input.into());
self
}
/// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
/// <ul>
/// <li>
/// <p>stream.standard.small</p></li>
/// <li>
/// <p>stream.standard.medium</p></li>
/// <li>
/// <p>stream.standard.large</p></li>
/// <li>
/// <p>stream.compute.large</p></li>
/// <li>
/// <p>stream.compute.xlarge</p></li>
/// <li>
/// <p>stream.compute.2xlarge</p></li>
/// <li>
/// <p>stream.compute.4xlarge</p></li>
/// <li>
/// <p>stream.compute.8xlarge</p></li>
/// <li>
/// <p>stream.memory.large</p></li>
/// <li>
/// <p>stream.memory.xlarge</p></li>
/// <li>
/// <p>stream.memory.2xlarge</p></li>
/// <li>
/// <p>stream.memory.4xlarge</p></li>
/// <li>
/// <p>stream.memory.8xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.large</p></li>
/// <li>
/// <p>stream.memory.z1d.xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.2xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.3xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.6xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.large</p></li>
/// <li>
/// <p>stream.graphics.g6f.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6f.4xlarge</p></li>
/// </ul>
pub fn set_instance_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.instance_type = input;
self
}
/// <p>The instance type to use when launching fleet instances. The following instance types are available:</p>
/// <ul>
/// <li>
/// <p>stream.standard.small</p></li>
/// <li>
/// <p>stream.standard.medium</p></li>
/// <li>
/// <p>stream.standard.large</p></li>
/// <li>
/// <p>stream.compute.large</p></li>
/// <li>
/// <p>stream.compute.xlarge</p></li>
/// <li>
/// <p>stream.compute.2xlarge</p></li>
/// <li>
/// <p>stream.compute.4xlarge</p></li>
/// <li>
/// <p>stream.compute.8xlarge</p></li>
/// <li>
/// <p>stream.memory.large</p></li>
/// <li>
/// <p>stream.memory.xlarge</p></li>
/// <li>
/// <p>stream.memory.2xlarge</p></li>
/// <li>
/// <p>stream.memory.4xlarge</p></li>
/// <li>
/// <p>stream.memory.8xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.large</p></li>
/// <li>
/// <p>stream.memory.z1d.xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.2xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.3xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.6xlarge</p></li>
/// <li>
/// <p>stream.memory.z1d.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g4dn.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g5.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.16xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.12xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6.24xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6.8xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.large</p></li>
/// <li>
/// <p>stream.graphics.g6f.xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.2xlarge</p></li>
/// <li>
/// <p>stream.graphics.g6f.4xlarge</p></li>
/// <li>
/// <p>stream.graphics.gr6f.4xlarge</p></li>
/// </ul>
pub fn get_instance_type(&self) -> &::std::option::Option<::std::string::String> {
&self.instance_type
}
/// <p>The fleet type.</p>
/// <dl>
/// <dt>
/// ALWAYS_ON
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// ON_DEMAND
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// </dl>
pub fn fleet_type(mut self, input: crate::types::FleetType) -> Self {
self.fleet_type = ::std::option::Option::Some(input);
self
}
/// <p>The fleet type.</p>
/// <dl>
/// <dt>
/// ALWAYS_ON
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// ON_DEMAND
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// </dl>
pub fn set_fleet_type(mut self, input: ::std::option::Option<crate::types::FleetType>) -> Self {
self.fleet_type = input;
self
}
/// <p>The fleet type.</p>
/// <dl>
/// <dt>
/// ALWAYS_ON
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// ON_DEMAND
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// </dl>
pub fn get_fleet_type(&self) -> &::std::option::Option<crate::types::FleetType> {
&self.fleet_type
}
/// <p>The capacity status for the fleet.</p>
/// This field is required.
pub fn compute_capacity_status(mut self, input: crate::types::ComputeCapacityStatus) -> Self {
self.compute_capacity_status = ::std::option::Option::Some(input);
self
}
/// <p>The capacity status for the fleet.</p>
pub fn set_compute_capacity_status(mut self, input: ::std::option::Option<crate::types::ComputeCapacityStatus>) -> Self {
self.compute_capacity_status = input;
self
}
/// <p>The capacity status for the fleet.</p>
pub fn get_compute_capacity_status(&self) -> &::std::option::Option<crate::types::ComputeCapacityStatus> {
&self.compute_capacity_status
}
/// <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>
/// <p>Specify a value between 600 and 360000.</p>
pub fn max_user_duration_in_seconds(mut self, input: i32) -> Self {
self.max_user_duration_in_seconds = ::std::option::Option::Some(input);
self
}
/// <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>
/// <p>Specify a value between 600 and 360000.</p>
pub fn set_max_user_duration_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_user_duration_in_seconds = input;
self
}
/// <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>
/// <p>Specify a value between 600 and 360000.</p>
pub fn get_max_user_duration_in_seconds(&self) -> &::std::option::Option<i32> {
&self.max_user_duration_in_seconds
}
/// <p>The amount of time that a streaming session remains active after users disconnect. If they 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>
/// <p>Specify a value between 60 and 36000.</p>
pub fn disconnect_timeout_in_seconds(mut self, input: i32) -> Self {
self.disconnect_timeout_in_seconds = ::std::option::Option::Some(input);
self
}
/// <p>The amount of time that a streaming session remains active after users disconnect. If they 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>
/// <p>Specify a value between 60 and 36000.</p>
pub fn set_disconnect_timeout_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.disconnect_timeout_in_seconds = input;
self
}
/// <p>The amount of time that a streaming session remains active after users disconnect. If they 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>
/// <p>Specify a value between 60 and 36000.</p>
pub fn get_disconnect_timeout_in_seconds(&self) -> &::std::option::Option<i32> {
&self.disconnect_timeout_in_seconds
}
/// <p>The current state for the fleet.</p>
/// This field is required.
pub fn state(mut self, input: crate::types::FleetState) -> Self {
self.state = ::std::option::Option::Some(input);
self
}
/// <p>The current state for the fleet.</p>
pub fn set_state(mut self, input: ::std::option::Option<crate::types::FleetState>) -> Self {
self.state = input;
self
}
/// <p>The current state for the fleet.</p>
pub fn get_state(&self) -> &::std::option::Option<crate::types::FleetState> {
&self.state
}
/// <p>The VPC configuration for the fleet.</p>
pub fn vpc_config(mut self, input: crate::types::VpcConfig) -> Self {
self.vpc_config = ::std::option::Option::Some(input);
self
}
/// <p>The VPC configuration for the fleet.</p>
pub fn set_vpc_config(mut self, input: ::std::option::Option<crate::types::VpcConfig>) -> Self {
self.vpc_config = input;
self
}
/// <p>The VPC configuration for the fleet.</p>
pub fn get_vpc_config(&self) -> &::std::option::Option<crate::types::VpcConfig> {
&self.vpc_config
}
/// <p>The time the fleet was created.</p>
pub fn created_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.created_time = ::std::option::Option::Some(input);
self
}
/// <p>The time the fleet was created.</p>
pub fn set_created_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.created_time = input;
self
}
/// <p>The time the fleet was created.</p>
pub fn get_created_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.created_time
}
/// Appends an item to `fleet_errors`.
///
/// To override the contents of this collection use [`set_fleet_errors`](Self::set_fleet_errors).
///
/// <p>The fleet errors.</p>
pub fn fleet_errors(mut self, input: crate::types::FleetError) -> Self {
let mut v = self.fleet_errors.unwrap_or_default();
v.push(input);
self.fleet_errors = ::std::option::Option::Some(v);
self
}
/// <p>The fleet errors.</p>
pub fn set_fleet_errors(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::FleetError>>) -> Self {
self.fleet_errors = input;
self
}
/// <p>The fleet errors.</p>
pub fn get_fleet_errors(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::FleetError>> {
&self.fleet_errors
}
/// <p>Indicates whether default internet access is enabled for the fleet.</p>
pub fn enable_default_internet_access(mut self, input: bool) -> Self {
self.enable_default_internet_access = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether default internet access is enabled for the fleet.</p>
pub fn set_enable_default_internet_access(mut self, input: ::std::option::Option<bool>) -> Self {
self.enable_default_internet_access = input;
self
}
/// <p>Indicates whether default internet access is enabled for the fleet.</p>
pub fn get_enable_default_internet_access(&self) -> &::std::option::Option<bool> {
&self.enable_default_internet_access
}
/// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.</p>
pub fn domain_join_info(mut self, input: crate::types::DomainJoinInfo) -> Self {
self.domain_join_info = ::std::option::Option::Some(input);
self
}
/// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.</p>
pub fn set_domain_join_info(mut self, input: ::std::option::Option<crate::types::DomainJoinInfo>) -> Self {
self.domain_join_info = input;
self
}
/// <p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.</p>
pub fn get_domain_join_info(&self) -> &::std::option::Option<crate::types::DomainJoinInfo> {
&self.domain_join_info
}
/// <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 users 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>
/// <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>
/// <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>
/// </note>
pub fn idle_disconnect_timeout_in_seconds(mut self, input: i32) -> Self {
self.idle_disconnect_timeout_in_seconds = ::std::option::Option::Some(input);
self
}
/// <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 users 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>
/// <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>
/// <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>
/// </note>
pub fn set_idle_disconnect_timeout_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.idle_disconnect_timeout_in_seconds = input;
self
}
/// <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 users 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>
/// <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>
/// <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>
/// </note>
pub fn get_idle_disconnect_timeout_in_seconds(&self) -> &::std::option::Option<i32> {
&self.idle_disconnect_timeout_in_seconds
}
/// <p>The ARN of the IAM role that is applied to the fleet. To assume a role, the 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>
/// <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>
pub fn iam_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.iam_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the IAM role that is applied to the fleet. To assume a role, the 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>
/// <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>
pub fn set_iam_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.iam_role_arn = input;
self
}
/// <p>The ARN of the IAM role that is applied to the fleet. To assume a role, the 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>
/// <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>
pub fn get_iam_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.iam_role_arn
}
/// <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>
/// <p>The default value is <code>APP</code>.</p>
pub fn stream_view(mut self, input: crate::types::StreamView) -> Self {
self.stream_view = ::std::option::Option::Some(input);
self
}
/// <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>
/// <p>The default value is <code>APP</code>.</p>
pub fn set_stream_view(mut self, input: ::std::option::Option<crate::types::StreamView>) -> Self {
self.stream_view = input;
self
}
/// <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>
/// <p>The default value is <code>APP</code>.</p>
pub fn get_stream_view(&self) -> &::std::option::Option<crate::types::StreamView> {
&self.stream_view
}
/// <p>The platform of the fleet.</p>
pub fn platform(mut self, input: crate::types::PlatformType) -> Self {
self.platform = ::std::option::Option::Some(input);
self
}
/// <p>The platform of the fleet.</p>
pub fn set_platform(mut self, input: ::std::option::Option<crate::types::PlatformType>) -> Self {
self.platform = input;
self
}
/// <p>The platform of the fleet.</p>
pub fn get_platform(&self) -> &::std::option::Option<crate::types::PlatformType> {
&self.platform
}
/// <p>The maximum number of concurrent sessions for the fleet.</p>
pub fn max_concurrent_sessions(mut self, input: i32) -> Self {
self.max_concurrent_sessions = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of concurrent sessions for the fleet.</p>
pub fn set_max_concurrent_sessions(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_concurrent_sessions = input;
self
}
/// <p>The maximum number of concurrent sessions for the fleet.</p>
pub fn get_max_concurrent_sessions(&self) -> &::std::option::Option<i32> {
&self.max_concurrent_sessions
}
/// Appends an item to `usb_device_filter_strings`.
///
/// To override the contents of this collection use [`set_usb_device_filter_strings`](Self::set_usb_device_filter_strings).
///
/// <p>The USB device filter strings associated with the fleet.</p>
pub fn usb_device_filter_strings(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.usb_device_filter_strings.unwrap_or_default();
v.push(input.into());
self.usb_device_filter_strings = ::std::option::Option::Some(v);
self
}
/// <p>The USB device filter strings associated with the fleet.</p>
pub fn set_usb_device_filter_strings(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.usb_device_filter_strings = input;
self
}
/// <p>The USB device filter strings associated with the fleet.</p>
pub fn get_usb_device_filter_strings(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.usb_device_filter_strings
}
/// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
pub fn session_script_s3_location(mut self, input: crate::types::S3Location) -> Self {
self.session_script_s3_location = ::std::option::Option::Some(input);
self
}
/// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
pub fn set_session_script_s3_location(mut self, input: ::std::option::Option<crate::types::S3Location>) -> Self {
self.session_script_s3_location = input;
self
}
/// <p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>
pub fn get_session_script_s3_location(&self) -> &::std::option::Option<crate::types::S3Location> {
&self.session_script_s3_location
}
/// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
pub fn max_sessions_per_instance(mut self, input: i32) -> Self {
self.max_sessions_per_instance = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
pub fn set_max_sessions_per_instance(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_sessions_per_instance = input;
self
}
/// <p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p>
pub fn get_max_sessions_per_instance(&self) -> &::std::option::Option<i32> {
&self.max_sessions_per_instance
}
/// <p>The current configuration of the root volume for fleet instances, including the storage size in GB.</p>
pub fn root_volume_config(mut self, input: crate::types::VolumeConfig) -> Self {
self.root_volume_config = ::std::option::Option::Some(input);
self
}
/// <p>The current configuration of the root volume for fleet instances, including the storage size in GB.</p>
pub fn set_root_volume_config(mut self, input: ::std::option::Option<crate::types::VolumeConfig>) -> Self {
self.root_volume_config = input;
self
}
/// <p>The current configuration of the root volume for fleet instances, including the storage size in GB.</p>
pub fn get_root_volume_config(&self) -> &::std::option::Option<crate::types::VolumeConfig> {
&self.root_volume_config
}
/// <p>Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.</p>
pub fn disable_imdsv1(mut self, input: bool) -> Self {
self.disable_imdsv1 = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.</p>
pub fn set_disable_imdsv1(mut self, input: ::std::option::Option<bool>) -> Self {
self.disable_imdsv1 = input;
self
}
/// <p>Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.</p>
pub fn get_disable_imdsv1(&self) -> &::std::option::Option<bool> {
&self.disable_imdsv1
}
/// Consumes the builder and constructs a [`Fleet`](crate::types::Fleet).
pub fn build(self) -> crate::types::Fleet {
crate::types::Fleet {
arn: self.arn,
name: self.name,
display_name: self.display_name,
description: self.description,
image_name: self.image_name,
image_arn: self.image_arn,
instance_type: self.instance_type,
fleet_type: self.fleet_type,
compute_capacity_status: self.compute_capacity_status,
max_user_duration_in_seconds: self.max_user_duration_in_seconds,
disconnect_timeout_in_seconds: self.disconnect_timeout_in_seconds,
state: self.state,
vpc_config: self.vpc_config,
created_time: self.created_time,
fleet_errors: self.fleet_errors,
enable_default_internet_access: self.enable_default_internet_access,
domain_join_info: self.domain_join_info,
idle_disconnect_timeout_in_seconds: self.idle_disconnect_timeout_in_seconds,
iam_role_arn: self.iam_role_arn,
stream_view: self.stream_view,
platform: self.platform,
max_concurrent_sessions: self.max_concurrent_sessions,
usb_device_filter_strings: self.usb_device_filter_strings,
session_script_s3_location: self.session_script_s3_location,
max_sessions_per_instance: self.max_sessions_per_instance,
root_volume_config: self.root_volume_config,
disable_imdsv1: self.disable_imdsv1,
}
}
}