Class: AWSCDK::WorkspacesWeb::CfnUserSettings

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSWorkspacesweb::IUserSettingsRef
Defined in:
workspaces_web/cfn_user_settings.rb

Overview

This resource specifies user settings that can be associated with a web portal.

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnUserSettings

Create a new AWS::WorkSpacesWeb::UserSettings.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::WorkspacesWeb::CfnUserSettingsProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'workspaces_web/cfn_user_settings.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettingsProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd29ya3NwYWNlc3dlYi5DZm5Vc2VyU2V0dGluZ3NQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_user_settings(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'workspaces_web/cfn_user_settings.rb', line 92

def self.(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c193b3Jrc3BhY2Vzd2ViLklVc2VyU2V0dGluZ3NSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspacesweb.CfnUserSettings", "arnForUserSettings", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


199
200
201
 
# File 'workspaces_web/cfn_user_settings.rb', line 199

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_workspacesweb.CfnUserSettings", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_user_settings(x) ⇒ Boolean

Checks whether the given object is a CfnUserSettings.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


101
102
103
104
 
# File 'workspaces_web/cfn_user_settings.rb', line 101

def self.(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspacesweb.CfnUserSettings", "isCfnUserSettings", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'workspaces_web/cfn_user_settings.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_associated_portal_arns => { kind: :property, name: "attrAssociatedPortalArns", is_optional: false },
    :attr_branding_configuration_favicon_metadata => { kind: :property, name: "attrBrandingConfigurationFaviconMetadata", is_optional: false },
    :attr_branding_configuration_logo_metadata => { kind: :property, name: "attrBrandingConfigurationLogoMetadata", is_optional: false },
    :attr_branding_configuration_wallpaper_metadata => { kind: :property, name: "attrBrandingConfigurationWallpaperMetadata", is_optional: false },
    :attr_user_settings_arn => { kind: :property, name: "attrUserSettingsArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :user_settings_ref => { kind: :property, name: "userSettingsRef", is_optional: false },
    :copy_allowed => { kind: :property, name: "copyAllowed", is_optional: false },
    :download_allowed => { kind: :property, name: "downloadAllowed", is_optional: false },
    :paste_allowed => { kind: :property, name: "pasteAllowed", is_optional: false },
    :print_allowed => { kind: :property, name: "printAllowed", is_optional: false },
    :upload_allowed => { kind: :property, name: "uploadAllowed", is_optional: false },
    :additional_encryption_context => { kind: :property, name: "additionalEncryptionContext", is_optional: true },
    :branding_configuration => { kind: :property, name: "brandingConfiguration", is_optional: true },
    :cookie_synchronization_configuration => { kind: :property, name: "cookieSynchronizationConfiguration", is_optional: true },
    :customer_managed_key => { kind: :property, name: "customerManagedKey", is_optional: true },
    :deep_link_allowed => { kind: :property, name: "deepLinkAllowed", is_optional: true },
    :disconnect_timeout_in_minutes => { kind: :property, name: "disconnectTimeoutInMinutes", is_optional: true },
    :idle_disconnect_timeout_in_minutes => { kind: :property, name: "idleDisconnectTimeoutInMinutes", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :toolbar_configuration => { kind: :property, name: "toolbarConfiguration", is_optional: true },
    :web_authn_allowed => { kind: :property, name: "webAuthnAllowed", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



478
479
480
481
 
# File 'workspaces_web/cfn_user_settings.rb', line 478

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



490
491
492
493
 
# File 'workspaces_web/cfn_user_settings.rb', line 490

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



500
501
502
503
 
# File 'workspaces_web/cfn_user_settings.rb', line 500

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



511
512
513
514
515
 
# File 'workspaces_web/cfn_user_settings.rb', line 511

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


568
569
570
571
572
 
# File 'workspaces_web/cfn_user_settings.rb', line 568

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



578
579
580
581
 
# File 'workspaces_web/cfn_user_settings.rb', line 578

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



590
591
592
593
594
 
# File 'workspaces_web/cfn_user_settings.rb', line 590

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#additional_encryption_context ⇒ AWSCDK::IResolvable, ...

The additional encryption context of the user settings.

Returns:



321
322
323
 
# File 'workspaces_web/cfn_user_settings.rb', line 321

def additional_encryption_context()
  jsii_get_property("additionalEncryptionContext")
end

#additional_encryption_context=(value) ⇒ Object 



325
326
327
328
 
# File 'workspaces_web/cfn_user_settings.rb', line 325

def additional_encryption_context=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "additionalEncryptionContext") unless value.nil?
  jsii_set_property("additionalEncryptionContext", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



603
604
605
606
 
# File 'workspaces_web/cfn_user_settings.rb', line 603

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



625
626
627
628
629
630
 
# File 'workspaces_web/cfn_user_settings.rb', line 625

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_associated_portal_arns ⇒ Array<String>

A list of web portal ARNs that this user settings resource is associated with.

Returns:

  • (Array<String>) 


206
207
208
 
# File 'workspaces_web/cfn_user_settings.rb', line 206

def attr_associated_portal_arns()
  jsii_get_property("attrAssociatedPortalArns")
end

#attr_branding_configuration_favicon_metadata ⇒ AWSCDK::IResolvable

Read-only.

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

Returns:



215
216
217
 
# File 'workspaces_web/cfn_user_settings.rb', line 215

def attr_branding_configuration_favicon_metadata()
  jsii_get_property("attrBrandingConfigurationFaviconMetadata")
end

#attr_branding_configuration_logo_metadata ⇒ AWSCDK::IResolvable

Read-only.

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

Returns:



224
225
226
 
# File 'workspaces_web/cfn_user_settings.rb', line 224

def attr_branding_configuration_logo_metadata()
  jsii_get_property("attrBrandingConfigurationLogoMetadata")
end

#attr_branding_configuration_wallpaper_metadata ⇒ AWSCDK::IResolvable

Read-only.

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

Returns:



233
234
235
 
# File 'workspaces_web/cfn_user_settings.rb', line 233

def attr_branding_configuration_wallpaper_metadata()
  jsii_get_property("attrBrandingConfigurationWallpaperMetadata")
end

#attr_user_settings_arn ⇒ String

The ARN of the user settings.

Returns:

  • (String) 


240
241
242
 
# File 'workspaces_web/cfn_user_settings.rb', line 240

def ()
  jsii_get_property("attrUserSettingsArn")
end

#branding_configuration ⇒ AWSCDK::IResolvable, ...

The branding configuration that customizes the appearance of the web portal for end users.

Returns:



333
334
335
 
# File 'workspaces_web/cfn_user_settings.rb', line 333

def branding_configuration()
  jsii_get_property("brandingConfiguration")
end

#branding_configuration=(value) ⇒ Object 



337
338
339
340
341
 
# File 'workspaces_web/cfn_user_settings.rb', line 337

def branding_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettings::BrandingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmblVzZXJTZXR0aW5ncy5CcmFuZGluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "brandingConfiguration") unless value.nil?
  jsii_set_property("brandingConfiguration", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



247
248
249
 
# File 'workspaces_web/cfn_user_settings.rb', line 247

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



152
153
154
 
# File 'workspaces_web/cfn_user_settings.rb', line 152

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


157
158
159
 
# File 'workspaces_web/cfn_user_settings.rb', line 157

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


634
635
636
637
 
# File 'workspaces_web/cfn_user_settings.rb', line 634

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


162
163
164
 
# File 'workspaces_web/cfn_user_settings.rb', line 162

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


169
170
171
 
# File 'workspaces_web/cfn_user_settings.rb', line 169

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cookie_synchronization_configuration ⇒ AWSCDK::IResolvable, ...

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

Returns:



346
347
348
 
# File 'workspaces_web/cfn_user_settings.rb', line 346

def cookie_synchronization_configuration()
  jsii_get_property("cookieSynchronizationConfiguration")
end

#cookie_synchronization_configuration=(value) ⇒ Object 



350
351
352
353
354
 
# File 'workspaces_web/cfn_user_settings.rb', line 350

def cookie_synchronization_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettings::CookieSynchronizationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmblVzZXJTZXR0aW5ncy5Db29raWVTeW5jaHJvbml6YXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "cookieSynchronizationConfiguration") unless value.nil?
  jsii_set_property("cookieSynchronizationConfiguration", value)
end

#copy_allowed ⇒ String

Specifies whether the user can copy text from the streaming session to the local device.

Returns:

  • (String) 


261
262
263
 
# File 'workspaces_web/cfn_user_settings.rb', line 261

def copy_allowed()
  jsii_get_property("copyAllowed")
end

#copy_allowed=(value) ⇒ Object 



265
266
267
268
 
# File 'workspaces_web/cfn_user_settings.rb', line 265

def copy_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "copyAllowed")
  jsii_set_property("copyAllowed", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


114
115
116
 
# File 'workspaces_web/cfn_user_settings.rb', line 114

def creation_stack()
  jsii_get_property("creationStack")
end

#customer_managed_key ⇒ String?

The customer managed key used to encrypt sensitive information in the user settings.

Returns:

  • (String, nil) 


359
360
361
 
# File 'workspaces_web/cfn_user_settings.rb', line 359

def customer_managed_key()
  jsii_get_property("customerManagedKey")
end

#customer_managed_key=(value) ⇒ Object 



363
364
365
366
 
# File 'workspaces_web/cfn_user_settings.rb', line 363

def customer_managed_key=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customerManagedKey") unless value.nil?
  jsii_set_property("customerManagedKey", value)
end

#deep_link_allowed ⇒ String?

Specifies whether the user can use deep links that open automatically when connecting to a session.

Returns:

  • (String, nil) 


371
372
373
 
# File 'workspaces_web/cfn_user_settings.rb', line 371

def deep_link_allowed()
  jsii_get_property("deepLinkAllowed")
end

#deep_link_allowed=(value) ⇒ Object 



375
376
377
378
 
# File 'workspaces_web/cfn_user_settings.rb', line 375

def deep_link_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deepLinkAllowed") unless value.nil?
  jsii_set_property("deepLinkAllowed", value)
end

#disconnect_timeout_in_minutes ⇒ Numeric?

The amount of time that a streaming session remains active after users disconnect.

Returns:

  • (Numeric, nil) 


383
384
385
 
# File 'workspaces_web/cfn_user_settings.rb', line 383

def disconnect_timeout_in_minutes()
  jsii_get_property("disconnectTimeoutInMinutes")
end

#disconnect_timeout_in_minutes=(value) ⇒ Object 



387
388
389
390
 
# File 'workspaces_web/cfn_user_settings.rb', line 387

def disconnect_timeout_in_minutes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "disconnectTimeoutInMinutes") unless value.nil?
  jsii_set_property("disconnectTimeoutInMinutes", value)
end

#download_allowed ⇒ String

Specifies whether the user can download files from the streaming session to the local device.

Returns:

  • (String) 


273
274
275
 
# File 'workspaces_web/cfn_user_settings.rb', line 273

def download_allowed()
  jsii_get_property("downloadAllowed")
end

#download_allowed=(value) ⇒ Object 



277
278
279
280
 
# File 'workspaces_web/cfn_user_settings.rb', line 277

def download_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "downloadAllowed")
  jsii_set_property("downloadAllowed", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



174
175
176
 
# File 'workspaces_web/cfn_user_settings.rb', line 174

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



647
648
649
650
651
 
# File 'workspaces_web/cfn_user_settings.rb', line 647

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



658
659
660
661
 
# File 'workspaces_web/cfn_user_settings.rb', line 658

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#idle_disconnect_timeout_in_minutes ⇒ Numeric?

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

Returns:

  • (Numeric, nil) 


395
396
397
 
# File 'workspaces_web/cfn_user_settings.rb', line 395

def idle_disconnect_timeout_in_minutes()
  jsii_get_property("idleDisconnectTimeoutInMinutes")
end

#idle_disconnect_timeout_in_minutes=(value) ⇒ Object 



399
400
401
402
 
# File 'workspaces_web/cfn_user_settings.rb', line 399

def idle_disconnect_timeout_in_minutes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idleDisconnectTimeoutInMinutes") unless value.nil?
  jsii_set_property("idleDisconnectTimeoutInMinutes", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



728
729
730
731
 
# File 'workspaces_web/cfn_user_settings.rb', line 728

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


126
127
128
 
# File 'workspaces_web/cfn_user_settings.rb', line 126

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


109
110
111
 
# File 'workspaces_web/cfn_user_settings.rb', line 109

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



669
670
671
 
# File 'workspaces_web/cfn_user_settings.rb', line 669

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



676
677
678
 
# File 'workspaces_web/cfn_user_settings.rb', line 676

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



469
470
471
472
 
# File 'workspaces_web/cfn_user_settings.rb', line 469

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#paste_allowed ⇒ String

Specifies whether the user can paste text from the local device to the streaming session.

Returns:

  • (String) 


285
286
287
 
# File 'workspaces_web/cfn_user_settings.rb', line 285

def paste_allowed()
  jsii_get_property("pasteAllowed")
end

#paste_allowed=(value) ⇒ Object 



289
290
291
292
 
# File 'workspaces_web/cfn_user_settings.rb', line 289

def paste_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pasteAllowed")
  jsii_set_property("pasteAllowed", value)
end

#print_allowed ⇒ String

Specifies whether the user can print to the local device.

Returns:

  • (String) 


297
298
299
 
# File 'workspaces_web/cfn_user_settings.rb', line 297

def print_allowed()
  jsii_get_property("printAllowed")
end

#print_allowed=(value) ⇒ Object 



301
302
303
304
 
# File 'workspaces_web/cfn_user_settings.rb', line 301

def print_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "printAllowed")
  jsii_set_property("printAllowed", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


145
146
147
 
# File 'workspaces_web/cfn_user_settings.rb', line 145

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



687
688
689
690
 
# File 'workspaces_web/cfn_user_settings.rb', line 687

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


694
695
696
697
 
# File 'workspaces_web/cfn_user_settings.rb', line 694

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



704
705
706
707
708
 
# File 'workspaces_web/cfn_user_settings.rb', line 704

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



713
714
715
 
# File 'workspaces_web/cfn_user_settings.rb', line 713

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



135
136
137
 
# File 'workspaces_web/cfn_user_settings.rb', line 135

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags to add to the user settings resource.

Returns:



407
408
409
 
# File 'workspaces_web/cfn_user_settings.rb', line 407

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



411
412
413
414
415
 
# File 'workspaces_web/cfn_user_settings.rb', line 411

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



445
446
447
 
# File 'workspaces_web/cfn_user_settings.rb', line 445

def to_string()
  jsii_call_method("toString", [])
end

#toolbar_configuration ⇒ AWSCDK::IResolvable, ...

The configuration of the toolbar.

Returns:



420
421
422
 
# File 'workspaces_web/cfn_user_settings.rb', line 420

def toolbar_configuration()
  jsii_get_property("toolbarConfiguration")
end

#toolbar_configuration=(value) ⇒ Object 



424
425
426
427
428
 
# File 'workspaces_web/cfn_user_settings.rb', line 424

def toolbar_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettings::ToolbarConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmblVzZXJTZXR0aW5ncy5Ub29sYmFyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "toolbarConfiguration") unless value.nil?
  jsii_set_property("toolbarConfiguration", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


182
183
184
 
# File 'workspaces_web/cfn_user_settings.rb', line 182

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


192
193
194
 
# File 'workspaces_web/cfn_user_settings.rb', line 192

def updated_properties()
  jsii_get_property("updatedProperties")
end

#upload_allowed ⇒ String

Specifies whether the user can upload files from the local device to the streaming session.

Returns:

  • (String) 


309
310
311
 
# File 'workspaces_web/cfn_user_settings.rb', line 309

def upload_allowed()
  jsii_get_property("uploadAllowed")
end

#upload_allowed=(value) ⇒ Object 



313
314
315
316
 
# File 'workspaces_web/cfn_user_settings.rb', line 313

def upload_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "uploadAllowed")
  jsii_set_property("uploadAllowed", value)
end

#user_settings_ref ⇒ AWSCDK::Interfaces::AWSWorkspacesweb::UserSettingsReference

A reference to a UserSettings resource.

Returns:



254
255
256
 
# File 'workspaces_web/cfn_user_settings.rb', line 254

def ()
  jsii_get_property("userSettingsRef")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


719
720
721
722
 
# File 'workspaces_web/cfn_user_settings.rb', line 719

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#web_authn_allowed ⇒ String?

Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Returns:

  • (String, nil) 


433
434
435
 
# File 'workspaces_web/cfn_user_settings.rb', line 433

def web_authn_allowed()
  jsii_get_property("webAuthnAllowed")
end

#web_authn_allowed=(value) ⇒ Object 



437
438
439
440
 
# File 'workspaces_web/cfn_user_settings.rb', line 437

def web_authn_allowed=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webAuthnAllowed") unless value.nil?
  jsii_set_property("webAuthnAllowed", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


458
459
460
461
462
463
 
# File 'workspaces_web/cfn_user_settings.rb', line 458

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end