Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppStream.UpdateFleet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name.

If the fleet is in the RUNNING state, you can update the following based on the fleet type:

Always-On and On-Demand fleet types
You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes.
Elastic fleet type
You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes.

If the fleet is in the STARTING or STOPPED state, you can't update it.

Synopsis

data UpdateFleet = UpdateFleet' {
- attributesToDelete :: Maybe [FleetAttribute]
- computeCapacity :: Maybe ComputeCapacity
- deleteVpcConfig :: Maybe Bool
- description :: Maybe Text
- disconnectTimeoutInSeconds :: Maybe Int
- displayName :: Maybe Text
- domainJoinInfo :: Maybe DomainJoinInfo
- enableDefaultInternetAccess :: Maybe Bool
- iamRoleArn :: Maybe Text
- idleDisconnectTimeoutInSeconds :: Maybe Int
- imageArn :: Maybe Text
- imageName :: Maybe Text
- instanceType :: Maybe Text
- maxConcurrentSessions :: Maybe Int
- maxUserDurationInSeconds :: Maybe Int
- name :: Maybe Text
- platform :: Maybe PlatformType
- sessionScriptS3Location :: Maybe S3Location
- streamView :: Maybe StreamView
- usbDeviceFilterStrings :: Maybe [Text]
- vpcConfig :: Maybe VpcConfig
}
newUpdateFleet :: UpdateFleet
updateFleet_attributesToDelete :: Lens' UpdateFleet (Maybe [FleetAttribute])
updateFleet_computeCapacity :: Lens' UpdateFleet (Maybe ComputeCapacity)
updateFleet_deleteVpcConfig :: Lens' UpdateFleet (Maybe Bool)
updateFleet_description :: Lens' UpdateFleet (Maybe Text)
updateFleet_disconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int)
updateFleet_displayName :: Lens' UpdateFleet (Maybe Text)
updateFleet_domainJoinInfo :: Lens' UpdateFleet (Maybe DomainJoinInfo)
updateFleet_enableDefaultInternetAccess :: Lens' UpdateFleet (Maybe Bool)
updateFleet_iamRoleArn :: Lens' UpdateFleet (Maybe Text)
updateFleet_idleDisconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int)
updateFleet_imageArn :: Lens' UpdateFleet (Maybe Text)
updateFleet_imageName :: Lens' UpdateFleet (Maybe Text)
updateFleet_instanceType :: Lens' UpdateFleet (Maybe Text)
updateFleet_maxConcurrentSessions :: Lens' UpdateFleet (Maybe Int)
updateFleet_maxUserDurationInSeconds :: Lens' UpdateFleet (Maybe Int)
updateFleet_name :: Lens' UpdateFleet (Maybe Text)
updateFleet_platform :: Lens' UpdateFleet (Maybe PlatformType)
updateFleet_sessionScriptS3Location :: Lens' UpdateFleet (Maybe S3Location)
updateFleet_streamView :: Lens' UpdateFleet (Maybe StreamView)
updateFleet_usbDeviceFilterStrings :: Lens' UpdateFleet (Maybe [Text])
updateFleet_vpcConfig :: Lens' UpdateFleet (Maybe VpcConfig)
data UpdateFleetResponse = UpdateFleetResponse' {
- fleet :: Maybe Fleet
- httpStatus :: Int
}
newUpdateFleetResponse :: Int -> UpdateFleetResponse
updateFleetResponse_fleet :: Lens' UpdateFleetResponse (Maybe Fleet)
updateFleetResponse_httpStatus :: Lens' UpdateFleetResponse Int

Creating a Request

data UpdateFleet Source #

See: newUpdateFleet smart constructor.

Constructors

UpdateFleet'

Fields

attributesToDelete :: Maybe [FleetAttribute]
The fleet attributes to delete.
computeCapacity :: Maybe ComputeCapacity
The desired capacity for the fleet. This is not allowed for Elastic fleets.
deleteVpcConfig :: Maybe Bool
Deletes the VPC association for the specified fleet.
description :: Maybe Text
The description to display.
disconnectTimeoutInSeconds :: Maybe Int
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.
displayName :: Maybe Text
The fleet name to display.
domainJoinInfo :: Maybe DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
enableDefaultInternetAccess :: Maybe Bool
Enables or disables default internet access for the fleet.
iamRoleArn :: Maybe Text
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.
idleDisconnectTimeoutInSeconds :: Maybe Int
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.
imageArn :: Maybe Text
The ARN of the public, private, or shared image to use.
imageName :: Maybe Text
The name of the image used to create the fleet.
instanceType :: Maybe Text
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.standard.xlarge
- stream.standard.2xlarge
- 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
- stream.standard.large
- stream.standard.xlarge
- stream.standard.2xlarge
maxConcurrentSessions :: Maybe Int
The maximum number of concurrent sessions for a fleet.
maxUserDurationInSeconds :: Maybe Int
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.
name :: Maybe Text
A unique name for the fleet.
platform :: Maybe PlatformType
The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
sessionScriptS3Location :: Maybe S3Location
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
streamView :: Maybe 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.
usbDeviceFilterStrings :: Maybe [Text]
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.
vpcConfig :: Maybe 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.

Instances

Instances details

ToJSON UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods toJSON :: UpdateFleet -> Value # toEncoding :: UpdateFleet -> Encoding # toJSONList :: [UpdateFleet] -> Value # toEncodingList :: [UpdateFleet] -> Encoding #
ToHeaders UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods toHeaders :: UpdateFleet -> [Header] #
ToPath UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods toPath :: UpdateFleet -> ByteString #
ToQuery UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods toQuery :: UpdateFleet -> QueryString #
AWSRequest UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Associated Types type AWSResponse UpdateFleet # Methods request :: (Service -> Service) -> UpdateFleet -> Request UpdateFleet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateFleet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFleet))) #
Generic UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Associated Types type Rep UpdateFleet :: Type -> Type # Methods from :: UpdateFleet -> Rep UpdateFleet x # to :: Rep UpdateFleet x -> UpdateFleet #
Read UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods readsPrec :: Int -> ReadS UpdateFleet # readList :: ReadS [UpdateFleet] # readPrec :: ReadPrec UpdateFleet # readListPrec :: ReadPrec [UpdateFleet] #
Show UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods showsPrec :: Int -> UpdateFleet -> ShowS # show :: UpdateFleet -> String # showList :: [UpdateFleet] -> ShowS #
NFData UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods rnf :: UpdateFleet -> () #
Eq UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods (==) :: UpdateFleet -> UpdateFleet -> Bool # (/=) :: UpdateFleet -> UpdateFleet -> Bool #
Hashable UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods hashWithSalt :: Int -> UpdateFleet -> Int # hash :: UpdateFleet -> Int #
type AWSResponse UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet type AWSResponse UpdateFleet = UpdateFleetResponse
type Rep UpdateFleet Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet type Rep UpdateFleet = D1 ('MetaData "UpdateFleet" "Amazonka.AppStream.UpdateFleet" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "UpdateFleet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "attributesToDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FleetAttribute])) :: S1 ('MetaSel ('Just "computeCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeCapacity))) :: (S1 ('MetaSel ('Just "deleteVpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "disconnectTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainJoinInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainJoinInfo))) :: (S1 ('MetaSel ('Just "enableDefaultInternetAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "idleDisconnectTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :: (((S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxConcurrentSessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "maxUserDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlatformType)) :: S1 ('MetaSel ('Just "sessionScriptS3Location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Location)))) :: (S1 ('MetaSel ('Just "streamView") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamView)) :: (S1 ('MetaSel ('Just "usbDeviceFilterStrings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))))))

newUpdateFleet :: UpdateFleet Source #

Create a value of UpdateFleet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributesToDelete:UpdateFleet', updateFleet_attributesToDelete - The fleet attributes to delete.

$sel:computeCapacity:UpdateFleet', updateFleet_computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic fleets.

$sel:deleteVpcConfig:UpdateFleet', updateFleet_deleteVpcConfig - Deletes the VPC association for the specified fleet.

UpdateFleet, updateFleet_description - The description to display.

UpdateFleet, updateFleet_disconnectTimeoutInSeconds - 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.

UpdateFleet, updateFleet_displayName - The fleet name to display.

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

UpdateFleet, updateFleet_enableDefaultInternetAccess - Enables or disables default internet access for the fleet.

UpdateFleet, updateFleet_iamRoleArn - 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.

UpdateFleet, updateFleet_idleDisconnectTimeoutInSeconds - 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.

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

UpdateFleet, updateFleet_imageName - The name of the image used to create the fleet.

UpdateFleet, updateFleet_instanceType - 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.standard.xlarge
stream.standard.2xlarge
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
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge

UpdateFleet, updateFleet_maxConcurrentSessions - The maximum number of concurrent sessions for a fleet.

UpdateFleet, updateFleet_maxUserDurationInSeconds - 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.

UpdateFleet, updateFleet_name - A unique name for the fleet.

UpdateFleet, updateFleet_platform - The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.

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

UpdateFleet, updateFleet_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.

UpdateFleet, updateFleet_usbDeviceFilterStrings - 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.

UpdateFleet, updateFleet_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.

Request Lenses

updateFleet_attributesToDelete :: Lens' UpdateFleet (Maybe [FleetAttribute]) Source #

The fleet attributes to delete.

updateFleet_computeCapacity :: Lens' UpdateFleet (Maybe ComputeCapacity) Source #

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

updateFleet_deleteVpcConfig :: Lens' UpdateFleet (Maybe Bool) Source #

Deletes the VPC association for the specified fleet.

updateFleet_description :: Lens' UpdateFleet (Maybe Text) Source #

The description to display.

updateFleet_disconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int) Source #

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.

updateFleet_displayName :: Lens' UpdateFleet (Maybe Text) Source #

The fleet name to display.

updateFleet_domainJoinInfo :: Lens' UpdateFleet (Maybe DomainJoinInfo) Source #

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

updateFleet_enableDefaultInternetAccess :: Lens' UpdateFleet (Maybe Bool) Source #

Enables or disables default internet access for the fleet.

updateFleet_iamRoleArn :: Lens' UpdateFleet (Maybe Text) Source #

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.

updateFleet_idleDisconnectTimeoutInSeconds :: Lens' UpdateFleet (Maybe Int) Source #

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.

updateFleet_imageArn :: Lens' UpdateFleet (Maybe Text) Source #

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

updateFleet_imageName :: Lens' UpdateFleet (Maybe Text) Source #

The name of the image used to create the fleet.

updateFleet_instanceType :: Lens' UpdateFleet (Maybe Text) Source #

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.standard.xlarge
stream.standard.2xlarge
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
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge

updateFleet_maxConcurrentSessions :: Lens' UpdateFleet (Maybe Int) Source #

The maximum number of concurrent sessions for a fleet.

updateFleet_maxUserDurationInSeconds :: Lens' UpdateFleet (Maybe Int) Source #

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.

updateFleet_name :: Lens' UpdateFleet (Maybe Text) Source #

A unique name for the fleet.

updateFleet_platform :: Lens' UpdateFleet (Maybe PlatformType) Source #

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

updateFleet_sessionScriptS3Location :: Lens' UpdateFleet (Maybe S3Location) Source #

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

updateFleet_streamView :: Lens' UpdateFleet (Maybe StreamView) Source #

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.

updateFleet_usbDeviceFilterStrings :: Lens' UpdateFleet (Maybe [Text]) Source #

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.

updateFleet_vpcConfig :: Lens' UpdateFleet (Maybe VpcConfig) Source #

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.

Destructuring the Response

data UpdateFleetResponse Source #

See: newUpdateFleetResponse smart constructor.

Constructors

UpdateFleetResponse'
Fields fleet :: Maybe Fleet Information about the fleet. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateFleetResponse Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Associated Types type Rep UpdateFleetResponse :: Type -> Type # Methods from :: UpdateFleetResponse -> Rep UpdateFleetResponse x # to :: Rep UpdateFleetResponse x -> UpdateFleetResponse #
Read UpdateFleetResponse Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods readsPrec :: Int -> ReadS UpdateFleetResponse # readList :: ReadS [UpdateFleetResponse] # readPrec :: ReadPrec UpdateFleetResponse # readListPrec :: ReadPrec [UpdateFleetResponse] #
Show UpdateFleetResponse Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods showsPrec :: Int -> UpdateFleetResponse -> ShowS # show :: UpdateFleetResponse -> String # showList :: [UpdateFleetResponse] -> ShowS #
NFData UpdateFleetResponse Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods rnf :: UpdateFleetResponse -> () #
Eq UpdateFleetResponse Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet Methods (==) :: UpdateFleetResponse -> UpdateFleetResponse -> Bool # (/=) :: UpdateFleetResponse -> UpdateFleetResponse -> Bool #
type Rep UpdateFleetResponse Source #
Instance details Defined in Amazonka.AppStream.UpdateFleet type Rep UpdateFleetResponse = D1 ('MetaData "UpdateFleetResponse" "Amazonka.AppStream.UpdateFleet" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "UpdateFleetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Fleet)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateFleetResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateFleetResponse'`
-> UpdateFleetResponse

Create a value of UpdateFleetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fleet:UpdateFleetResponse', updateFleetResponse_fleet - Information about the fleet.

$sel:httpStatus:UpdateFleetResponse', updateFleetResponse_httpStatus - The response's http status code.

Response Lenses

updateFleetResponse_fleet :: Lens' UpdateFleetResponse (Maybe Fleet) Source #

Information about the fleet.

updateFleetResponse_httpStatus :: Lens' UpdateFleetResponse Int Source #

The response's http status code.