Class UserSetting

java.lang.Object
software.amazon.awssdk.services.appstream.model.UserSetting
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserSetting.Builder,UserSetting>

@Generated("software.amazon.awssdk:codegen") public final class UserSetting extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserSetting.Builder,UserSetting>

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

See Also:
  • Method Details

    • action

      public final Action action()

      The action you want to enable or disable. Choose from the following:

      AUTO_TIME_ZONE_REDIRECTION

      Controls whether the streaming session's time zone matches the time zone of your local device.

      CLIPBOARD_COPY_FROM_LOCAL_DEVICE

      Controls whether you can copy data from your local device and paste it into the streaming session.

      CLIPBOARD_COPY_TO_LOCAL_DEVICE

      Controls whether you can copy data from the streaming session and paste it to your local device.

      DOMAIN_PASSWORD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using your password.

      DOMAIN_SMART_CARD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using a smart card.

      FILE_DOWNLOAD

      Controls whether you can download files from the streaming session to your local device.

      FILE_UPLOAD

      Controls whether you can upload files from your local device to the streaming session.

      PRINTING_TO_LOCAL_DEVICE

      Controls whether you can print from the streaming session to a printer on your local device.

      SMART_CARD_REDIRECTION

      Controls whether smart cards connected to your local device are redirected into the streaming session. Applications in the session can access the local smart card for use cases such as authentication, digital signing, and email encryption.

      Smart card redirection was on by default for existing streaming sessions that use a Windows single-session fleet. To preserve that behavior, SMART_CARD_REDIRECTION is ENABLED by default on existing stacks associated with Windows single-session fleets. To turn it off, call UpdateStack with SMART_CARD_REDIRECTION set to DISABLED, and use an image that includes the latest WorkSpaces Applications agent version.

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

      Returns:
      The action you want to enable or disable. Choose from the following:

      AUTO_TIME_ZONE_REDIRECTION

      Controls whether the streaming session's time zone matches the time zone of your local device.

      CLIPBOARD_COPY_FROM_LOCAL_DEVICE

      Controls whether you can copy data from your local device and paste it into the streaming session.

      CLIPBOARD_COPY_TO_LOCAL_DEVICE

      Controls whether you can copy data from the streaming session and paste it to your local device.

      DOMAIN_PASSWORD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using your password.

      DOMAIN_SMART_CARD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using a smart card.

      FILE_DOWNLOAD

      Controls whether you can download files from the streaming session to your local device.

      FILE_UPLOAD

      Controls whether you can upload files from your local device to the streaming session.

      PRINTING_TO_LOCAL_DEVICE

      Controls whether you can print from the streaming session to a printer on your local device.

      SMART_CARD_REDIRECTION

      Controls whether smart cards connected to your local device are redirected into the streaming session. Applications in the session can access the local smart card for use cases such as authentication, digital signing, and email encryption.

      Smart card redirection was on by default for existing streaming sessions that use a Windows single-session fleet. To preserve that behavior, SMART_CARD_REDIRECTION is ENABLED by default on existing stacks associated with Windows single-session fleets. To turn it off, call UpdateStack with SMART_CARD_REDIRECTION set to DISABLED, and use an image that includes the latest WorkSpaces Applications agent version.

      See Also:
    • actionAsString

      public final String actionAsString()

      The action you want to enable or disable. Choose from the following:

      AUTO_TIME_ZONE_REDIRECTION

      Controls whether the streaming session's time zone matches the time zone of your local device.

      CLIPBOARD_COPY_FROM_LOCAL_DEVICE

      Controls whether you can copy data from your local device and paste it into the streaming session.

      CLIPBOARD_COPY_TO_LOCAL_DEVICE

      Controls whether you can copy data from the streaming session and paste it to your local device.

      DOMAIN_PASSWORD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using your password.

      DOMAIN_SMART_CARD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using a smart card.

      FILE_DOWNLOAD

      Controls whether you can download files from the streaming session to your local device.

      FILE_UPLOAD

      Controls whether you can upload files from your local device to the streaming session.

      PRINTING_TO_LOCAL_DEVICE

      Controls whether you can print from the streaming session to a printer on your local device.

      SMART_CARD_REDIRECTION

      Controls whether smart cards connected to your local device are redirected into the streaming session. Applications in the session can access the local smart card for use cases such as authentication, digital signing, and email encryption.

      Smart card redirection was on by default for existing streaming sessions that use a Windows single-session fleet. To preserve that behavior, SMART_CARD_REDIRECTION is ENABLED by default on existing stacks associated with Windows single-session fleets. To turn it off, call UpdateStack with SMART_CARD_REDIRECTION set to DISABLED, and use an image that includes the latest WorkSpaces Applications agent version.

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

      Returns:
      The action you want to enable or disable. Choose from the following:

      AUTO_TIME_ZONE_REDIRECTION

      Controls whether the streaming session's time zone matches the time zone of your local device.

      CLIPBOARD_COPY_FROM_LOCAL_DEVICE

      Controls whether you can copy data from your local device and paste it into the streaming session.

      CLIPBOARD_COPY_TO_LOCAL_DEVICE

      Controls whether you can copy data from the streaming session and paste it to your local device.

      DOMAIN_PASSWORD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using your password.

      DOMAIN_SMART_CARD_SIGNIN

      Controls whether you can sign in to a domain-joined streaming session by using a smart card.

      FILE_DOWNLOAD

      Controls whether you can download files from the streaming session to your local device.

      FILE_UPLOAD

      Controls whether you can upload files from your local device to the streaming session.

      PRINTING_TO_LOCAL_DEVICE

      Controls whether you can print from the streaming session to a printer on your local device.

      SMART_CARD_REDIRECTION

      Controls whether smart cards connected to your local device are redirected into the streaming session. Applications in the session can access the local smart card for use cases such as authentication, digital signing, and email encryption.

      Smart card redirection was on by default for existing streaming sessions that use a Windows single-session fleet. To preserve that behavior, SMART_CARD_REDIRECTION is ENABLED by default on existing stacks associated with Windows single-session fleets. To turn it off, call UpdateStack with SMART_CARD_REDIRECTION set to DISABLED, and use an image that includes the latest WorkSpaces Applications agent version.

      See Also:
    • permission

      public final Permission permission()

      Specifies whether to turn the action on or off.

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

      Returns:
      Specifies whether to turn the action on or off.
      See Also:
    • permissionAsString

      public final String permissionAsString()

      Specifies whether to turn the action on or off.

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

      Returns:
      Specifies whether to turn the action on or off.
      See Also:
    • maximumLength

      public final Integer maximumLength()

      Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

      This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

      This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

      The value can be between 1 and 20,971,520 (20 MB).

      Returns:
      Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

      This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

      This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

      The value can be between 1 and 20,971,520 (20 MB).

    • toBuilder

      public UserSetting.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<UserSetting.Builder,UserSetting>
      Returns:
      a builder for type T
    • builder

      public static UserSetting.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UserSetting.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.