libZSservicesZSamazonka-appstreamZSamazonka-appstream
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppStream.Types.Fleet

Description

 
Synopsis

Documentation

data Fleet Source #

Describes a fleet.

See: newFleet smart constructor.

Constructors

Fleet' 

Fields

  • domainJoinInfo :: Maybe DomainJoinInfo

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

  • iamRoleArn :: Maybe Text

    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) 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.

  • disconnectTimeoutInSeconds :: Maybe Int

    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.

    Specify a value between 60 and 360000.

  • 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.

  • createdTime :: Maybe POSIX

    The time the fleet was created.

  • 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.

  • fleetType :: Maybe FleetType

    The fleet type.

    ALWAYS_ON
    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.
    ON_DEMAND
    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.
  • vpcConfig :: Maybe VpcConfig

    The VPC configuration for the fleet.

  • imageArn :: Maybe Text

    The ARN for the public, private, or shared image.

  • fleetErrors :: Maybe [FleetError]

    The fleet errors.

  • displayName :: Maybe Text

    The fleet name to display.

  • enableDefaultInternetAccess :: Maybe Bool

    Indicates whether default internet access is enabled for the fleet.

  • imageName :: Maybe Text

    The name of the image used to create the fleet.

  • description :: Maybe Text

    The description to display.

  • 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.

  • arn :: Text

    The Amazon Resource Name (ARN) for the fleet.

  • name :: Text

    The name of the fleet.

  • instanceType :: 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.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
  • computeCapacityStatus :: ComputeCapacityStatus

    The capacity status for the fleet.

  • state :: FleetState

    The current state for the fleet.

Instances

Instances details
Eq Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

Methods

(==) :: Fleet -> Fleet -> Bool #

(/=) :: Fleet -> Fleet -> Bool #

Read Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

Show Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

Methods

showsPrec :: Int -> Fleet -> ShowS #

show :: Fleet -> String #

showList :: [Fleet] -> ShowS #

Generic Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

Associated Types

type Rep Fleet :: Type -> Type #

Methods

from :: Fleet -> Rep Fleet x #

to :: Rep Fleet x -> Fleet #

NFData Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

Methods

rnf :: Fleet -> () #

Hashable Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

Methods

hashWithSalt :: Int -> Fleet -> Int #

hash :: Fleet -> Int #

FromJSON Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

type Rep Fleet Source # 
Instance details

Defined in Amazonka.AppStream.Types.Fleet

type Rep Fleet = D1 ('MetaData "Fleet" "Amazonka.AppStream.Types.Fleet" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "Fleet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "domainJoinInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainJoinInfo)) :*: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "disconnectTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "maxUserDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "idleDisconnectTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "fleetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetType))) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: (S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fleetErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FleetError])))))) :*: (((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enableDefaultInternetAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamView") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamView))))) :*: ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "computeCapacityStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ComputeCapacityStatus) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FleetState)))))))

newFleet Source #

Create a value of Fleet 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:domainJoinInfo:Fleet', fleet_domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

$sel:iamRoleArn:Fleet', fleet_iamRoleArn - 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) 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.

$sel:disconnectTimeoutInSeconds:Fleet', fleet_disconnectTimeoutInSeconds - 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.

Specify a value between 60 and 360000.

$sel:maxUserDurationInSeconds:Fleet', fleet_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.

$sel:createdTime:Fleet', fleet_createdTime - The time the fleet was created.

$sel:idleDisconnectTimeoutInSeconds:Fleet', fleet_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.

$sel:fleetType:Fleet', fleet_fleetType - The fleet type.

ALWAYS_ON
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.
ON_DEMAND
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.

$sel:vpcConfig:Fleet', fleet_vpcConfig - The VPC configuration for the fleet.

$sel:imageArn:Fleet', fleet_imageArn - The ARN for the public, private, or shared image.

$sel:fleetErrors:Fleet', fleet_fleetErrors - The fleet errors.

$sel:displayName:Fleet', fleet_displayName - The fleet name to display.

$sel:enableDefaultInternetAccess:Fleet', fleet_enableDefaultInternetAccess - Indicates whether default internet access is enabled for the fleet.

$sel:imageName:Fleet', fleet_imageName - The name of the image used to create the fleet.

$sel:description:Fleet', fleet_description - The description to display.

$sel:streamView:Fleet', fleet_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.

$sel:arn:Fleet', fleet_arn - The Amazon Resource Name (ARN) for the fleet.

$sel:name:Fleet', fleet_name - The name of the fleet.

$sel:instanceType:Fleet', fleet_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.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

$sel:computeCapacityStatus:Fleet', fleet_computeCapacityStatus - The capacity status for the fleet.

$sel:state:Fleet', fleet_state - The current state for the fleet.

fleet_domainJoinInfo :: Lens' Fleet (Maybe DomainJoinInfo) Source #

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

fleet_iamRoleArn :: Lens' Fleet (Maybe Text) Source #

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) 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.

fleet_disconnectTimeoutInSeconds :: Lens' Fleet (Maybe Int) Source #

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.

Specify a value between 60 and 360000.

fleet_maxUserDurationInSeconds :: Lens' Fleet (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.

fleet_createdTime :: Lens' Fleet (Maybe UTCTime) Source #

The time the fleet was created.

fleet_idleDisconnectTimeoutInSeconds :: Lens' Fleet (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.

fleet_fleetType :: Lens' Fleet (Maybe FleetType) Source #

The fleet type.

ALWAYS_ON
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.
ON_DEMAND
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.

fleet_vpcConfig :: Lens' Fleet (Maybe VpcConfig) Source #

The VPC configuration for the fleet.

fleet_imageArn :: Lens' Fleet (Maybe Text) Source #

The ARN for the public, private, or shared image.

fleet_displayName :: Lens' Fleet (Maybe Text) Source #

The fleet name to display.

fleet_enableDefaultInternetAccess :: Lens' Fleet (Maybe Bool) Source #

Indicates whether default internet access is enabled for the fleet.

fleet_imageName :: Lens' Fleet (Maybe Text) Source #

The name of the image used to create the fleet.

fleet_description :: Lens' Fleet (Maybe Text) Source #

The description to display.

fleet_streamView :: Lens' Fleet (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.

fleet_arn :: Lens' Fleet Text Source #

The Amazon Resource Name (ARN) for the fleet.

fleet_name :: Lens' Fleet Text Source #

The name of the fleet.

fleet_instanceType :: Lens' Fleet 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.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

fleet_state :: Lens' Fleet FleetState Source #

The current state for the fleet.