Struct aws_sdk_appstream::input::update_fleet_input::Builder

pub struct Builder { /* private fields */ }

A builder for UpdateFleetInput.

Implementations

impl Builder

pub fn image_name(self, input: impl Into<String>) -> Self

The name of the image used to create the fleet.

Examples found in repository

src/client.rs (line 7858)

        pub fn image_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.image_name(input.into());
            self
        }

pub fn set_image_name(self, input: Option<String>) -> Self

The name of the image used to create the fleet.

Examples found in repository

src/client.rs (line 7863)

        pub fn set_image_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_image_name(input);
            self
        }

pub fn image_arn(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 7868)

        pub fn image_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.image_arn(input.into());
            self
        }

pub fn set_image_arn(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 7873)

        pub fn set_image_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_image_arn(input);
            self
        }

pub fn name(self, input: impl Into<String>) -> Self

A unique name for the fleet.

Examples found in repository

src/client.rs (line 7878)

        pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.name(input.into());
            self
        }

pub fn set_name(self, input: Option<String>) -> Self

A unique name for the fleet.

Examples found in repository

src/client.rs (line 7883)

        pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_name(input);
            self
        }

pub fn instance_type(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 7928)

        pub fn instance_type(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.instance_type(input.into());
            self
        }

pub fn set_instance_type(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 7976)

        pub fn set_instance_type(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_instance_type(input);
            self
        }

pub fn compute_capacity(self, input: ComputeCapacity) -> Self

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

Examples found in repository

src/client.rs (line 7981)

        pub fn compute_capacity(mut self, input: crate::model::ComputeCapacity) -> Self {
            self.inner = self.inner.compute_capacity(input);
            self
        }

pub fn set_compute_capacity(self, input: Option<ComputeCapacity>) -> Self

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

Examples found in repository

src/client.rs (line 7989)

        pub fn set_compute_capacity(
            mut self,
            input: std::option::Option<crate::model::ComputeCapacity>,
        ) -> Self {
            self.inner = self.inner.set_compute_capacity(input);
            self
        }

pub fn vpc_config(self, input: VpcConfig) -> Self

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.

Examples found in repository

src/client.rs (line 7994)

        pub fn vpc_config(mut self, input: crate::model::VpcConfig) -> Self {
            self.inner = self.inner.vpc_config(input);
            self
        }

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

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.

Examples found in repository

src/client.rs (line 8002)

        pub fn set_vpc_config(
            mut self,
            input: std::option::Option<crate::model::VpcConfig>,
        ) -> Self {
            self.inner = self.inner.set_vpc_config(input);
            self
        }

pub fn max_user_duration_in_seconds(self, input: i32) -> Self

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.

Examples found in repository

src/client.rs (line 8008)

        pub fn max_user_duration_in_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.max_user_duration_in_seconds(input);
            self
        }

pub fn set_max_user_duration_in_seconds(self, input: Option<i32>) -> Self

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.

Examples found in repository

src/client.rs (line 8014)

        pub fn set_max_user_duration_in_seconds(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_max_user_duration_in_seconds(input);
            self
        }

pub fn disconnect_timeout_in_seconds(self, input: i32) -> Self

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.

Examples found in repository

src/client.rs (line 8020)

        pub fn disconnect_timeout_in_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.disconnect_timeout_in_seconds(input);
            self
        }

pub fn set_disconnect_timeout_in_seconds(self, input: Option<i32>) -> Self

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.

Examples found in repository

src/client.rs (line 8029)

        pub fn set_disconnect_timeout_in_seconds(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_disconnect_timeout_in_seconds(input);
            self
        }

pub fn delete_vpc_config(self, input: bool) -> Self

👎Deprecated

Deletes the VPC association for the specified fleet.

Examples found in repository

src/client.rs (line 8035)

        pub fn delete_vpc_config(mut self, input: bool) -> Self {
            self.inner = self.inner.delete_vpc_config(input);
            self
        }

pub fn set_delete_vpc_config(self, input: Option<bool>) -> Self

👎Deprecated

Deletes the VPC association for the specified fleet.

Examples found in repository

src/client.rs (line 8041)

        pub fn set_delete_vpc_config(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_delete_vpc_config(input);
            self
        }

pub fn description(self, input: impl Into<String>) -> Self

The description to display.

Examples found in repository

src/client.rs (line 8046)

        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

pub fn set_description(self, input: Option<String>) -> Self

The description to display.

Examples found in repository

src/client.rs (line 8051)

        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

pub fn display_name(self, input: impl Into<String>) -> Self

The fleet name to display.

Examples found in repository

src/client.rs (line 8056)

        pub fn display_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.display_name(input.into());
            self
        }

pub fn set_display_name(self, input: Option<String>) -> Self

The fleet name to display.

Examples found in repository

src/client.rs (line 8061)

        pub fn set_display_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_display_name(input);
            self
        }

pub fn enable_default_internet_access(self, input: bool) -> Self

Enables or disables default internet access for the fleet.

Examples found in repository

src/client.rs (line 8066)

        pub fn enable_default_internet_access(mut self, input: bool) -> Self {
            self.inner = self.inner.enable_default_internet_access(input);
            self
        }

pub fn set_enable_default_internet_access(self, input: Option<bool>) -> Self

Enables or disables default internet access for the fleet.

Examples found in repository

src/client.rs (line 8074)

        pub fn set_enable_default_internet_access(
            mut self,
            input: std::option::Option<bool>,
        ) -> Self {
            self.inner = self.inner.set_enable_default_internet_access(input);
            self
        }

pub fn domain_join_info(self, input: DomainJoinInfo) -> Self

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

Examples found in repository

src/client.rs (line 8079)

        pub fn domain_join_info(mut self, input: crate::model::DomainJoinInfo) -> Self {
            self.inner = self.inner.domain_join_info(input);
            self
        }

pub fn set_domain_join_info(self, input: Option<DomainJoinInfo>) -> Self

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

Examples found in repository

src/client.rs (line 8087)

        pub fn set_domain_join_info(
            mut self,
            input: std::option::Option<crate::model::DomainJoinInfo>,
        ) -> Self {
            self.inner = self.inner.set_domain_join_info(input);
            self
        }

pub fn idle_disconnect_timeout_in_seconds(self, input: i32) -> Self

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.

Examples found in repository

src/client.rs (line 8095)

        pub fn idle_disconnect_timeout_in_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.idle_disconnect_timeout_in_seconds(input);
            self
        }

pub fn set_idle_disconnect_timeout_in_seconds(self, input: Option<i32>) -> Self

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.

Examples found in repository

src/client.rs (line 8106)

        pub fn set_idle_disconnect_timeout_in_seconds(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_idle_disconnect_timeout_in_seconds(input);
            self
        }

pub fn attributes_to_delete(self, input: FleetAttribute) -> Self

Appends an item to attributes_to_delete.

To override the contents of this collection use set_attributes_to_delete.

The fleet attributes to delete.

Examples found in repository

src/client.rs (line 8115)

        pub fn attributes_to_delete(mut self, input: crate::model::FleetAttribute) -> Self {
            self.inner = self.inner.attributes_to_delete(input);
            self
        }

pub fn set_attributes_to_delete(self, input: Option<Vec<FleetAttribute>>) -> Self

The fleet attributes to delete.

Examples found in repository

src/client.rs (line 8123)

        pub fn set_attributes_to_delete(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::FleetAttribute>>,
        ) -> Self {
            self.inner = self.inner.set_attributes_to_delete(input);
            self
        }

pub fn iam_role_arn(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 8129)

        pub fn iam_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.iam_role_arn(input.into());
            self
        }

pub fn set_iam_role_arn(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 8135)

        pub fn set_iam_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_iam_role_arn(input);
            self
        }

pub fn stream_view(self, input: StreamView) -> Self

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.

Examples found in repository

src/client.rs (line 8141)

        pub fn stream_view(mut self, input: crate::model::StreamView) -> Self {
            self.inner = self.inner.stream_view(input);
            self
        }

pub fn set_stream_view(self, input: Option<StreamView>) -> Self

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.

Examples found in repository

src/client.rs (line 8150)

        pub fn set_stream_view(
            mut self,
            input: std::option::Option<crate::model::StreamView>,
        ) -> Self {
            self.inner = self.inner.set_stream_view(input);
            self
        }

pub fn platform(self, input: PlatformType) -> Self

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

Examples found in repository

src/client.rs (line 8155)

        pub fn platform(mut self, input: crate::model::PlatformType) -> Self {
            self.inner = self.inner.platform(input);
            self
        }

pub fn set_platform(self, input: Option<PlatformType>) -> Self

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

Examples found in repository

src/client.rs (line 8163)

        pub fn set_platform(
            mut self,
            input: std::option::Option<crate::model::PlatformType>,
        ) -> Self {
            self.inner = self.inner.set_platform(input);
            self
        }

pub fn max_concurrent_sessions(self, input: i32) -> Self

The maximum number of concurrent sessions for a fleet.

Examples found in repository

src/client.rs (line 8168)

        pub fn max_concurrent_sessions(mut self, input: i32) -> Self {
            self.inner = self.inner.max_concurrent_sessions(input);
            self
        }

pub fn set_max_concurrent_sessions(self, input: Option<i32>) -> Self

The maximum number of concurrent sessions for a fleet.

Examples found in repository

src/client.rs (line 8173)

        pub fn set_max_concurrent_sessions(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_max_concurrent_sessions(input);
            self
        }

pub fn usb_device_filter_strings(self, input: impl Into<String>) -> Self

Appends an item to usb_device_filter_strings.

To override the contents of this collection use set_usb_device_filter_strings.

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.

Examples found in repository

src/client.rs (line 8182)

        pub fn usb_device_filter_strings(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.usb_device_filter_strings(input.into());
            self
        }

pub fn set_usb_device_filter_strings(self, input: Option<Vec<String>>) -> Self

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.

Examples found in repository

src/client.rs (line 8190)

        pub fn set_usb_device_filter_strings(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_usb_device_filter_strings(input);
            self
        }

pub fn session_script_s3_location(self, input: S3Location) -> Self

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

Examples found in repository

src/client.rs (line 8195)

        pub fn session_script_s3_location(mut self, input: crate::model::S3Location) -> Self {
            self.inner = self.inner.session_script_s3_location(input);
            self
        }

pub fn set_session_script_s3_location(self, input: Option<S3Location>) -> Self

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

Examples found in repository

src/client.rs (line 8203)

        pub fn set_session_script_s3_location(
            mut self,
            input: std::option::Option<crate::model::S3Location>,
        ) -> Self {
            self.inner = self.inner.set_session_script_s3_location(input);
            self
        }

pub fn build(self) -> Result<UpdateFleetInput, BuildError>

Consumes the builder and constructs a UpdateFleetInput.

Examples found in repository

src/client.rs (line 7825)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::UpdateFleet,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::UpdateFleetError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::UpdateFleetOutput,
            aws_smithy_http::result::SdkError<crate::error::UpdateFleetError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder