Package software.amazon.awssdk.services.appstream.model

Interface Fleet.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Fleet.Builder,Fleet>, SdkBuilder<Fleet.Builder,Fleet>, SdkPojo
Enclosing class:
Fleet
public static interface Fleet.Builder extends SdkPojo, CopyableBuilder<Fleet.Builder,Fleet>

  • Method Details

    • arn

      Fleet.Builder arn(String arn)

      The Amazon Resource Name (ARN) for the fleet.

      Parameters:
      arn - The Amazon Resource Name (ARN) for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Fleet.Builder name(String name)

      The name of the fleet.

      Parameters:
      name - The name of the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      Fleet.Builder displayName(String displayName)

      The fleet name to display.

      Parameters:
      displayName - The fleet name to display.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Fleet.Builder description(String description)

      The description to display.

      Parameters:
      description - The description to display.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageName

      Fleet.Builder imageName(String imageName)

      The name of the image used to create the fleet.

      Parameters:
      imageName - The name of the image used to create the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageArn

      Fleet.Builder imageArn(String imageArn)

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

      Parameters:
      imageArn - The ARN for the public, private, or shared image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      Fleet.Builder instanceType(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.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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetType

      Fleet.Builder fleetType(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fleetType

      Fleet.Builder fleetType(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computeCapacityStatus

      Fleet.Builder computeCapacityStatus(ComputeCapacityStatus computeCapacityStatus)

      The capacity status for the fleet.

      Parameters:
      computeCapacityStatus - The capacity status for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeCapacityStatus

      default Fleet.Builder computeCapacityStatus(Consumer<ComputeCapacityStatus.Builder> computeCapacityStatus)

      The capacity status for the fleet.

      This is a convenience method that creates an instance of the ComputeCapacityStatus.Builder avoiding the need to create one manually via ComputeCapacityStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to computeCapacityStatus(ComputeCapacityStatus).

      Parameters:
      computeCapacityStatus - a consumer that will call methods on ComputeCapacityStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxUserDurationInSeconds

      Fleet.Builder maxUserDurationInSeconds(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 360000.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disconnectTimeoutInSeconds

      Fleet.Builder disconnectTimeoutInSeconds(Integer 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Fleet.Builder state(String state)

      The current state for the fleet.

      Parameters:
      state - The current state for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Fleet.Builder state(FleetState state)

      The current state for the fleet.

      Parameters:
      state - The current state for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      Fleet.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC configuration for the fleet.

      Parameters:
      vpcConfig - The VPC configuration for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default Fleet.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      The VPC configuration for the fleet.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTime

      Fleet.Builder createdTime(Instant createdTime)

      The time the fleet was created.

      Parameters:
      createdTime - The time the fleet was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetErrors

      Fleet.Builder fleetErrors(Collection<FleetError> fleetErrors)

      The fleet errors.

      Parameters:
      fleetErrors - The fleet errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetErrors

      Fleet.Builder fleetErrors(FleetError... fleetErrors)

      The fleet errors.

      Parameters:
      fleetErrors - The fleet errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetErrors

      Fleet.Builder fleetErrors(Consumer<FleetError.Builder>... fleetErrors)

      The fleet errors.

      This is a convenience method that creates an instance of the FleetError.Builder avoiding the need to create one manually via FleetError.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fleetErrors(List<FleetError>).

      Parameters:
      fleetErrors - a consumer that will call methods on FleetError.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableDefaultInternetAccess

      Fleet.Builder enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)

      Indicates whether default internet access is enabled for the fleet.

      Parameters:
      enableDefaultInternetAccess - Indicates whether default internet access is enabled for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainJoinInfo

      Fleet.Builder domainJoinInfo(DomainJoinInfo domainJoinInfo)

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

      Parameters:
      domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainJoinInfo

      default Fleet.Builder domainJoinInfo(Consumer<DomainJoinInfo.Builder> domainJoinInfo)

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

      This is a convenience method that creates an instance of the DomainJoinInfo.Builder avoiding the need to create one manually via DomainJoinInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainJoinInfo(DomainJoinInfo).

      Parameters:
      domainJoinInfo - a consumer that will call methods on DomainJoinInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idleDisconnectTimeoutInSeconds

      Fleet.Builder idleDisconnectTimeoutInSeconds(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 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoleArn

      Fleet.Builder iamRoleArn(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamView

      Fleet.Builder streamView(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamView

      Fleet.Builder streamView(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      Fleet.Builder platform(String platform)

      The platform of the fleet.

      Parameters:
      platform - The platform of the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      Fleet.Builder platform(PlatformType platform)

      The platform of the fleet.

      Parameters:
      platform - The platform of the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxConcurrentSessions

      Fleet.Builder maxConcurrentSessions(Integer maxConcurrentSessions)

      The maximum number of concurrent sessions for the fleet.

      Parameters:
      maxConcurrentSessions - The maximum number of concurrent sessions for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usbDeviceFilterStrings

      Fleet.Builder usbDeviceFilterStrings(Collection<String> usbDeviceFilterStrings)

      The USB device filter strings associated with the fleet.

      Parameters:
      usbDeviceFilterStrings - The USB device filter strings associated with the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usbDeviceFilterStrings

      Fleet.Builder usbDeviceFilterStrings(String... usbDeviceFilterStrings)

      The USB device filter strings associated with the fleet.

      Parameters:
      usbDeviceFilterStrings - The USB device filter strings associated with the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionScriptS3Location

      Fleet.Builder sessionScriptS3Location(S3Location sessionScriptS3Location)

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

      Parameters:
      sessionScriptS3Location - The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionScriptS3Location

      default Fleet.Builder sessionScriptS3Location(Consumer<S3Location.Builder> sessionScriptS3Location)

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

      This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionScriptS3Location(S3Location).

      Parameters:
      sessionScriptS3Location - a consumer that will call methods on S3Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxSessionsPerInstance

      Fleet.Builder maxSessionsPerInstance(Integer maxSessionsPerInstance)

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

      Parameters:
      maxSessionsPerInstance - The maximum number of user sessions on an instance. This only applies to multi-session fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.