Class: AWSCDK::AppStream::CfnStack::UserSettingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_stream/cfn_stack.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action:, permission:, maximum_length: nil) ⇒ UserSettingProperty

Returns a new instance of UserSettingProperty.

Parameters:

  • action (String) —

    The action that is enabled or disabled.

  • permission (String) —

    Indicates whether the action is enabled or disabled.

  • maximum_length (Numeric, nil) (defaults to: nil) —

    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.



973
974
975
976
977
978
979
980
 
# File 'app_stream/cfn_stack.rb', line 973

def initialize(action:, permission:, maximum_length: nil)
  @action = action
  Jsii::Type.check_type(@action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "action")
  @permission = permission
  Jsii::Type.check_type(@permission, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "permission")
  @maximum_length = maximum_length
  Jsii::Type.check_type(@maximum_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumLength") unless @maximum_length.nil?
end

Instance Attribute Details

#action ⇒ String (readonly)

The action that is enabled or disabled.

Returns:

  • (String)

See Also:



986
987
988
 
# File 'app_stream/cfn_stack.rb', line 986

def action
  @action
end

#maximum_length ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



1002
1003
1004
 
# File 'app_stream/cfn_stack.rb', line 1002

def maximum_length
  @maximum_length
end

#permission ⇒ String (readonly)

Indicates whether the action is enabled or disabled.

Returns:

  • (String)

See Also:



991
992
993
 
# File 'app_stream/cfn_stack.rb', line 991

def permission
  @permission
end

Class Method Details

.jsii_properties ⇒ Object 



1004
1005
1006
1007
1008
1009
1010
 
# File 'app_stream/cfn_stack.rb', line 1004

def self.jsii_properties
  {
    :action => "action",
    :permission => "permission",
    :maximum_length => "maximumLength",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'app_stream/cfn_stack.rb', line 1012

def to_jsii
  result = {}
  result.merge!({
    "action" => @action,
    "permission" => @permission,
    "maximumLength" => @maximum_length,
  })
  result.compact
end