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

Class UpdateFleetRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.appstream.model.AppStreamRequest
software.amazon.awssdk.services.appstream.model.UpdateFleetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFleetRequest extends AppStreamRequest implements ToCopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>

  • Method Details

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

    • name

      public final String name()

      A unique name for the fleet.

      Returns:
      A unique name for the fleet.

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

    • computeCapacity

      public final ComputeCapacity computeCapacity()

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

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

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

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

    • deleteVpcConfig

      @Deprecated public final Boolean deleteVpcConfig()
      Deprecated.

      Deletes the VPC association for the specified fleet.

      Returns:
      Deletes the VPC association for the specified fleet.

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

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

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

    • attributesToDelete

      public final List<FleetAttribute> attributesToDelete()

      The fleet attributes to delete.

      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 hasAttributesToDelete() method.

      Returns:
      The fleet attributes to delete.

    • hasAttributesToDelete

      public final boolean hasAttributesToDelete()
      For responses, this returns true if the service returned a value for the AttributesToDelete 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.

    • attributesToDeleteAsStrings

      public final List<String> attributesToDeleteAsStrings()

      The fleet attributes to delete.

      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 hasAttributesToDelete() method.

      Returns:
      The fleet attributes to delete.

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

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

    • platform

      public final PlatformType platform()

      The platform of the fleet. 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 platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
      See Also:

    • platformAsString

      public final String platformAsString()

      The platform of the fleet. 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 platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
      See Also:

    • maxConcurrentSessions

      public final Integer maxConcurrentSessions()

      The maximum number of concurrent sessions for a fleet.

      Returns:
      The maximum number of concurrent sessions for a fleet.

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

    • toBuilder

      public UpdateFleetRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateFleetRequest.Builder,UpdateFleetRequest>
      Specified by:
      toBuilder in class AppStreamRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateFleetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFleetRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.