Struct aws_sdk_appstream::input::UpdateFleetInput

#[non_exhaustive]
pub struct UpdateFleetInput {

    pub image_name: Option<String>,
    pub image_arn: Option<String>,
    pub name: Option<String>,
    pub instance_type: Option<String>,
    pub compute_capacity: Option<ComputeCapacity>,
    pub vpc_config: Option<VpcConfig>,
    pub max_user_duration_in_seconds: Option<i32>,
    pub disconnect_timeout_in_seconds: Option<i32>,
    pub delete_vpc_config: bool,
    pub description: Option<String>,
    pub display_name: Option<String>,
    pub enable_default_internet_access: Option<bool>,
    pub domain_join_info: Option<DomainJoinInfo>,
    pub idle_disconnect_timeout_in_seconds: Option<i32>,
    pub attributes_to_delete: Option<Vec<FleetAttribute>>,
    pub iam_role_arn: Option<String>,
    pub stream_view: Option<StreamView>,
    pub platform: Option<PlatformType>,
    pub max_concurrent_sessions: Option<i32>,
    pub usb_device_filter_strings: Option<Vec<String>>,
    pub session_script_s3_location: Option<S3Location>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

image_name: Option<String>

The name of the image used to create the fleet.

image_arn: Option<String>

The ARN of the public, private, or shared image to use.

name: Option<String>

A unique name for the fleet.

instance_type: Option<String>

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

compute_capacity: Option<ComputeCapacity>

The desired capacity for the fleet. This is not allowed for Elastic fleets.

vpc_config: Option<VpcConfig>

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.

max_user_duration_in_seconds: Option<i32>

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.

Specify a value between 600 and 360000.

disconnect_timeout_in_seconds: Option<i32>

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.

Specify a value between 60 and 360000.

delete_vpc_config: bool

Deletes the VPC association for the specified fleet.

description: Option<String>

The description to display.

display_name: Option<String>

The fleet name to display.

enable_default_internet_access: Option<bool>

Enables or disables default internet access for the fleet.

domain_join_info: Option<DomainJoinInfo>

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

idle_disconnect_timeout_in_seconds: Option<i32>

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds 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 DisconnectTimeoutInSeconds 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 IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

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.

attributes_to_delete: Option<Vec<FleetAttribute>>

The fleet attributes to delete.

iam_role_arn: Option<String>

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) AssumeRole 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 appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

stream_view: Option<StreamView>

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

platform: Option<PlatformType>

The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

max_concurrent_sessions: Option<i32>

The maximum number of concurrent sessions for a fleet.

usb_device_filter_strings: Option<Vec<String>>

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.

session_script_s3_location: Option<S3Location>

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Implementations

impl UpdateFleetInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateFleet, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<UpdateFleet>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateFleetInput

impl UpdateFleetInput

pub fn image_name(&self) -> Option<&str>

The name of the image used to create the fleet.

pub fn image_arn(&self) -> Option<&str>

The ARN of the public, private, or shared image to use.

pub fn name(&self) -> Option<&str>

A unique name for the fleet.

pub fn instance_type(&self) -> Option<&str>

The instance type to use when launching fleet instances. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

• stream.standard.small

• stream.standard.medium

pub fn compute_capacity(&self) -> Option<&ComputeCapacity>

The desired capacity for the fleet. This is not allowed for Elastic fleets.

pub fn vpc_config(&self) -> Option<&VpcConfig>

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.

pub fn max_user_duration_in_seconds(&self) -> Option<i32>

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.

Specify a value between 600 and 360000.

pub fn disconnect_timeout_in_seconds(&self) -> Option<i32>

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.

Specify a value between 60 and 360000.

pub fn delete_vpc_config(&self) -> bool

Deletes the VPC association for the specified fleet.

pub fn description(&self) -> Option<&str>

The description to display.

pub fn display_name(&self) -> Option<&str>

The fleet name to display.

pub fn enable_default_internet_access(&self) -> Option<bool>

Enables or disables default internet access for the fleet.

pub fn domain_join_info(&self) -> Option<&DomainJoinInfo>

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

pub fn idle_disconnect_timeout_in_seconds(&self) -> Option<i32>

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds 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 DisconnectTimeoutInSeconds 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 IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

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.

pub fn attributes_to_delete(&self) -> Option<&[FleetAttribute]>

The fleet attributes to delete.

pub fn iam_role_arn(&self) -> Option<&str>

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) AssumeRole 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 appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

pub fn stream_view(&self) -> Option<&StreamView>

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

pub fn platform(&self) -> Option<&PlatformType>

The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

pub fn max_concurrent_sessions(&self) -> Option<i32>

The maximum number of concurrent sessions for a fleet.

pub fn usb_device_filter_strings(&self) -> Option<&[String]>

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.

pub fn session_script_s3_location(&self) -> Option<&S3Location>

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

Trait Implementations

impl Clone for UpdateFleetInput

fn clone(&self) -> UpdateFleetInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateFleetInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<UpdateFleetInput> for UpdateFleetInput

fn eq(&self, other: &UpdateFleetInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UpdateFleetInput) -> bool

This method tests for !=.

impl StructuralPartialEq for UpdateFleetInput