Class UserSetting
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<UserSetting.Builder,UserSetting>
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Actionaction()The action you want to enable or disable.final StringThe action you want to enable or disable.static UserSetting.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final IntegerSpecifies 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.final PermissionSpecifies whether to turn the action on or off.final StringSpecifies whether to turn the action on or off.static Class<? extends UserSetting.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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_REDIRECTIONisENABLEDby default on existing stacks associated with Windows single-session fleets. To turn it off, callUpdateStackwithSMART_CARD_REDIRECTIONset toDISABLED, 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,
actionwill returnAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromactionAsString().- 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_REDIRECTIONisENABLEDby default on existing stacks associated with Windows single-session fleets. To turn it off, callUpdateStackwithSMART_CARD_REDIRECTIONset toDISABLED, and use an image that includes the latest WorkSpaces Applications agent version. - See Also:
-
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_REDIRECTIONisENABLEDby default on existing stacks associated with Windows single-session fleets. To turn it off, callUpdateStackwithSMART_CARD_REDIRECTIONset toDISABLED, 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,
actionwill returnAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromactionAsString().- 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_REDIRECTIONisENABLEDby default on existing stacks associated with Windows single-session fleets. To turn it off, callUpdateStackwithSMART_CARD_REDIRECTIONset toDISABLED, and use an image that includes the latest WorkSpaces Applications agent version. - See Also:
-
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,
permissionwill returnPermission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionAsString().- Returns:
- Specifies whether to turn the action on or off.
- See Also:
-
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,
permissionwill returnPermission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionAsString().- Returns:
- Specifies whether to turn the action on or off.
- See Also:
-
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_DEVICEandCLIPBOARD_COPY_TO_LOCAL_DEVICEactions.This defaults to 20,971,520 (20 MB) when unspecified and the permission is
ENABLED. This can't be specified when the permission isDISABLED.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_DEVICEandCLIPBOARD_COPY_TO_LOCAL_DEVICEactions.This defaults to 20,971,520 (20 MB) when unspecified and the permission is
ENABLED. This can't be specified when the permission isDISABLED.The value can be between 1 and 20,971,520 (20 MB).
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<UserSetting.Builder,UserSetting> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-