aws_sdk_appstream/client/

update_fleet.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateFleet`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`image_name(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::image_name) / [`set_image_name(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_image_name):<br>required: **false**<br><p>The name of the image used to create the fleet.</p><br>
    ///   - [`image_arn(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::image_arn) / [`set_image_arn(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_image_arn):<br>required: **false**<br><p>The ARN of the public, private, or shared image to use.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_name):<br>required: **false**<br><p>A unique name for the fleet.</p><br>
    ///   - [`instance_type(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::instance_type) / [`set_instance_type(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_instance_type):<br>required: **false**<br><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.standard.xlarge</p></li>  <li>   <p>stream.standard.2xlarge</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-design.large</p></li>  <li>   <p>stream.graphics-design.xlarge</p></li>  <li>   <p>stream.graphics-design.2xlarge</p></li>  <li>   <p>stream.graphics-design.4xlarge</p></li>  <li>   <p>stream.graphics-desktop.2xlarge</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-pro.4xlarge</p></li>  <li>   <p>stream.graphics-pro.8xlarge</p></li>  <li>   <p>stream.graphics-pro.16xlarge</p></li> </ul> <p>The following instance types are available for Elastic fleets:</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.standard.xlarge</p></li>  <li>   <p>stream.standard.2xlarge</p></li> </ul><br>
    ///   - [`compute_capacity(ComputeCapacity)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::compute_capacity) / [`set_compute_capacity(Option<ComputeCapacity>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_compute_capacity):<br>required: **false**<br><p>The desired capacity for the fleet. This is not allowed for Elastic fleets.</p><br>
    ///   - [`vpc_config(VpcConfig)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::vpc_config) / [`set_vpc_config(Option<VpcConfig>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_vpc_config):<br>required: **false**<br><p>The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.</p><br>
    ///   - [`max_user_duration_in_seconds(i32)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::max_user_duration_in_seconds) / [`set_max_user_duration_in_seconds(Option<i32>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_max_user_duration_in_seconds):<br>required: **false**<br><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 432000.</p><br>
    ///   - [`disconnect_timeout_in_seconds(i32)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::disconnect_timeout_in_seconds) / [`set_disconnect_timeout_in_seconds(Option<i32>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_disconnect_timeout_in_seconds):<br>required: **false**<br><p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p> <p>Specify a value between 60 and 36000.</p><br>
    ///   - [`delete_vpc_config(bool)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::delete_vpc_config) / [`set_delete_vpc_config(Option<bool>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_delete_vpc_config):<br>required: **false**<br><p>Deletes the VPC association for the specified fleet.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_description):<br>required: **false**<br><p>The description to display.</p><br>
    ///   - [`display_name(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_display_name):<br>required: **false**<br><p>The fleet name to display.</p><br>
    ///   - [`enable_default_internet_access(bool)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::enable_default_internet_access) / [`set_enable_default_internet_access(Option<bool>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_enable_default_internet_access):<br>required: **false**<br><p>Enables or disables default internet access for the fleet.</p><br>
    ///   - [`domain_join_info(DomainJoinInfo)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::domain_join_info) / [`set_domain_join_info(Option<DomainJoinInfo>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_domain_join_info):<br>required: **false**<br><p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.</p><br>
    ///   - [`idle_disconnect_timeout_in_seconds(i32)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::idle_disconnect_timeout_in_seconds) / [`set_idle_disconnect_timeout_in_seconds(Option<i32>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_idle_disconnect_timeout_in_seconds):<br>required: **false**<br><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><br>
    ///   - [`attributes_to_delete(FleetAttribute)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::attributes_to_delete) / [`set_attributes_to_delete(Option<Vec::<FleetAttribute>>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_attributes_to_delete):<br>required: **false**<br><p>The fleet attributes to delete.</p><br>
    ///   - [`iam_role_arn(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::iam_role_arn) / [`set_iam_role_arn(Option<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_iam_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 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 AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p><br>
    ///   - [`stream_view(StreamView)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::stream_view) / [`set_stream_view(Option<StreamView>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_stream_view):<br>required: **false**<br><p>The AppStream 2.0 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><br>
    ///   - [`platform(PlatformType)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::platform) / [`set_platform(Option<PlatformType>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_platform):<br>required: **false**<br><p>The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.</p><br>
    ///   - [`max_concurrent_sessions(i32)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::max_concurrent_sessions) / [`set_max_concurrent_sessions(Option<i32>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_max_concurrent_sessions):<br>required: **false**<br><p>The maximum number of concurrent sessions for a fleet.</p><br>
    ///   - [`usb_device_filter_strings(impl Into<String>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::usb_device_filter_strings) / [`set_usb_device_filter_strings(Option<Vec::<String>>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_usb_device_filter_strings):<br>required: **false**<br><p>The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.</p><br>
    ///   - [`session_script_s3_location(S3Location)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::session_script_s3_location) / [`set_session_script_s3_location(Option<S3Location>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_session_script_s3_location):<br>required: **false**<br><p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p><br>
    ///   - [`max_sessions_per_instance(i32)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::max_sessions_per_instance) / [`set_max_sessions_per_instance(Option<i32>)`](crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::set_max_sessions_per_instance):<br>required: **false**<br><p>The maximum number of user sessions on an instance. This only applies to multi-session fleets.</p><br>
    /// - On success, responds with [`UpdateFleetOutput`](crate::operation::update_fleet::UpdateFleetOutput) with field(s):
    ///   - [`fleet(Option<Fleet>)`](crate::operation::update_fleet::UpdateFleetOutput::fleet): <p>Information about the fleet.</p>
    /// - On failure, responds with [`SdkError<UpdateFleetError>`](crate::operation::update_fleet::UpdateFleetError)
    pub fn update_fleet(&self) -> crate::operation::update_fleet::builders::UpdateFleetFluentBuilder {
        crate::operation::update_fleet::builders::UpdateFleetFluentBuilder::new(self.handle.clone())
    }
}