Class CreateFleetRequest

    • Method Detail

      • name

        public final String name()

        A unique name for the fleet.

        Returns:
        A unique name for the fleet.
      • imageName

        public final String imageName()

        The name of the image used to create the fleet.

        Returns:
        The name of the image used to create the fleet.
      • imageArn

        public final String imageArn()

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

        Returns:
        The ARN of the public, private, or shared image to use.
      • instanceType

        public final String 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.g5.xlarge

        • stream.graphics.g5.2xlarge

        • stream.graphics.g5.4xlarge

        • stream.graphics.g5.8xlarge

        • stream.graphics.g5.12xlarge

        • stream.graphics.g5.16xlarge

        • stream.graphics.g5.24xlarge

        • 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

        Returns:
        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.g5.xlarge

        • stream.graphics.g5.2xlarge

        • stream.graphics.g5.4xlarge

        • stream.graphics.g5.8xlarge

        • stream.graphics.g5.12xlarge

        • stream.graphics.g5.16xlarge

        • stream.graphics.g5.24xlarge

        • 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

      • fleetType

        public final FleetType 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.

        If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

        Returns:
        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.

        See Also:
        FleetType
      • fleetTypeAsString

        public final String fleetTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

        Returns:
        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.

        See Also:
        FleetType
      • computeCapacity

        public final ComputeCapacity computeCapacity()

        The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.

        Returns:
        The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
      • vpcConfig

        public final VpcConfig 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.

        Returns:
        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.
      • maxUserDurationInSeconds

        public final Integer 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 432000.

        Returns:
        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 432000.

      • disconnectTimeoutInSeconds

        public final Integer 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 36000.

        Returns:
        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 36000.

      • description

        public final String description()

        The description to display.

        Returns:
        The description to display.
      • displayName

        public final String displayName()

        The fleet name to display.

        Returns:
        The fleet name to display.
      • enableDefaultInternetAccess

        public final Boolean enableDefaultInternetAccess()

        Enables or disables default internet access for the fleet.

        Returns:
        Enables or disables default internet access for the fleet.
      • domainJoinInfo

        public final DomainJoinInfo domainJoinInfo()

        The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.

        Returns:
        The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final Map<String,​String> tags()

        The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

        If you do not specify a value, the value is set to an empty string.

        Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

        _ . : / = + \ - @

        For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

        If you do not specify a value, the value is set to an empty string.

        Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

        _ . : / = + \ - @

        For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

      • idleDisconnectTimeoutInSeconds

        public final Integer 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 they 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 36000. 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.

        Returns:
        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 they 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 36000. 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.

      • iamRoleArn

        public final String 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.

        Returns:
        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.

      • streamView

        public final StreamView 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.

        If the service returns an enum value that is not available in the current SDK version, streamView will return StreamView.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamViewAsString().

        Returns:
        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.

        See Also:
        StreamView
      • streamViewAsString

        public final String streamViewAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, streamView will return StreamView.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamViewAsString().

        Returns:
        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.

        See Also:
        StreamView
      • platform

        public final PlatformType platform()

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

        If the service returns an enum value that is not available in the current SDK version, platform will return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

        Returns:
        The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
        See Also:
        PlatformType
      • platformAsString

        public final String platformAsString()

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

        If the service returns an enum value that is not available in the current SDK version, platform will return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

        Returns:
        The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
        See Also:
        PlatformType
      • maxConcurrentSessions

        public final Integer maxConcurrentSessions()

        The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.

        Returns:
        The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
      • hasUsbDeviceFilterStrings

        public final boolean hasUsbDeviceFilterStrings()
        For responses, this returns true if the service returned a value for the UsbDeviceFilterStrings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • usbDeviceFilterStrings

        public final List<String> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsbDeviceFilterStrings() method.

        Returns:
        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.
      • sessionScriptS3Location

        public final S3Location sessionScriptS3Location()

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

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

        public final Integer maxSessionsPerInstance()

        The maximum number of user sessions on an instance. This only applies to multi-session fleets.

        Returns:
        The maximum number of user sessions on an instance. This only applies to multi-session fleets.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object