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

Interface UpdateFleetRequest.Builder

All Superinterfaces:
AppStreamRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>, SdkBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateFleetRequest
public static interface UpdateFleetRequest.Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>

  • Method Details

    • imageName

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

      UpdateFleetRequest.Builder imageArn(String imageArn)

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

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

    • name

      UpdateFleetRequest.Builder name(String name)

      A unique name for the fleet.

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

    • instanceType

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

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

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

    • computeCapacity

      UpdateFleetRequest.Builder computeCapacity(ComputeCapacity computeCapacity)

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

      Parameters:
      computeCapacity - The desired capacity for the fleet. This is not allowed for Elastic fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeCapacity

      default UpdateFleetRequest.Builder computeCapacity(Consumer<ComputeCapacity.Builder> computeCapacity)

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

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

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

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

    • vpcConfig

      UpdateFleetRequest.Builder vpcConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default UpdateFleetRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> 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.

      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:

    • maxUserDurationInSeconds

      UpdateFleetRequest.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 432000.

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

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

    • disconnectTimeoutInSeconds

      UpdateFleetRequest.Builder disconnectTimeoutInSeconds(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 360000.

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

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

    • deleteVpcConfig

      @Deprecated UpdateFleetRequest.Builder deleteVpcConfig(Boolean deleteVpcConfig)
      Deprecated.

      Deletes the VPC association for the specified fleet.

      Parameters:
      deleteVpcConfig - Deletes the VPC association for the specified fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

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

    • displayName

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

    • enableDefaultInternetAccess

      UpdateFleetRequest.Builder enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)

      Enables or disables default internet access for the fleet.

      Parameters:
      enableDefaultInternetAccess - Enables or disables default internet access for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainJoinInfo

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

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

    • attributesToDeleteWithStrings

      UpdateFleetRequest.Builder attributesToDeleteWithStrings(Collection<String> attributesToDelete)

      The fleet attributes to delete.

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

    • attributesToDeleteWithStrings

      UpdateFleetRequest.Builder attributesToDeleteWithStrings(String... attributesToDelete)

      The fleet attributes to delete.

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

    • attributesToDelete

      UpdateFleetRequest.Builder attributesToDelete(Collection<FleetAttribute> attributesToDelete)

      The fleet attributes to delete.

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

    • attributesToDelete

      UpdateFleetRequest.Builder attributesToDelete(FleetAttribute... attributesToDelete)

      The fleet attributes to delete.

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

    • iamRoleArn

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • streamView

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

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

      UpdateFleetRequest.Builder platform(String platform)

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

      Parameters:
      platform - The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      UpdateFleetRequest.Builder platform(PlatformType platform)

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

      Parameters:
      platform - The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxConcurrentSessions

      UpdateFleetRequest.Builder maxConcurrentSessions(Integer maxConcurrentSessions)

      The maximum number of concurrent sessions for a fleet.

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

    • usbDeviceFilterStrings

      UpdateFleetRequest.Builder usbDeviceFilterStrings(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usbDeviceFilterStrings

      UpdateFleetRequest.Builder usbDeviceFilterStrings(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionScriptS3Location

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

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

    • overrideConfiguration

      UpdateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.