Class: AWSCDK::WorkspacesWeb::CfnPortal

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

Overview

This resource specifies a web portal, which users use to start browsing sessions.

A Standard web portal can't start browsing sessions unless you have at defined and associated an IdentityProvider and NetworkSettings resource. An IAM Identity Center web portal does not require an IdentityProvider resource.

For more information about web portals, see What is Amazon WorkSpaces Secure Browser? .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnPortal

Create a new AWS::WorkSpacesWeb::Portal.

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::CfnPortalProps, nil) (defaults to: nil) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'workspaces_web/cfn_portal.rb', line 22

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnPortalProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd29ya3NwYWNlc3dlYi5DZm5Qb3J0YWxQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_portal(resource) ⇒ String

Parameters:

Returns:

  • (String) 


98
99
100
101
 
# File 'workspaces_web/cfn_portal.rb', line 98

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


205
206
207
 
# File 'workspaces_web/cfn_portal.rb', line 205

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

.is_cfn_portal(x) ⇒ Boolean

Checks whether the given object is a CfnPortal.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'workspaces_web/cfn_portal.rb', line 107

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

.jsii_overridable_methods ⇒ Object 



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
89
90
91
92
93
94
 
# File 'workspaces_web/cfn_portal.rb', line 30

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_browser_type => { kind: :property, name: "attrBrowserType", is_optional: false },
    :attr_creation_date => { kind: :property, name: "attrCreationDate", is_optional: false },
    :attr_portal_arn => { kind: :property, name: "attrPortalArn", is_optional: false },
    :attr_portal_endpoint => { kind: :property, name: "attrPortalEndpoint", is_optional: false },
    :attr_portal_status => { kind: :property, name: "attrPortalStatus", is_optional: false },
    :attr_renderer_type => { kind: :property, name: "attrRendererType", is_optional: false },
    :attr_service_provider_saml_metadata => { kind: :property, name: "attrServiceProviderSamlMetadata", is_optional: false },
    :attr_status_reason => { kind: :property, name: "attrStatusReason", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :portal_ref => { kind: :property, name: "portalRef", is_optional: false },
    :additional_encryption_context => { kind: :property, name: "additionalEncryptionContext", is_optional: true },
    :authentication_type => { kind: :property, name: "authenticationType", is_optional: true },
    :browser_settings_arn => { kind: :property, name: "browserSettingsArn", is_optional: true },
    :customer_managed_key => { kind: :property, name: "customerManagedKey", is_optional: true },
    :data_protection_settings_arn => { kind: :property, name: "dataProtectionSettingsArn", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :instance_type => { kind: :property, name: "instanceType", is_optional: true },
    :ip_access_settings_arn => { kind: :property, name: "ipAccessSettingsArn", is_optional: true },
    :max_concurrent_sessions => { kind: :property, name: "maxConcurrentSessions", is_optional: true },
    :network_settings_arn => { kind: :property, name: "networkSettingsArn", is_optional: true },
    :portal_custom_domain => { kind: :property, name: "portalCustomDomain", is_optional: true },
    :session_logger_arn => { kind: :property, name: "sessionLoggerArn", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :trust_store_arn => { kind: :property, name: "trustStoreArn", is_optional: true },
    :user_access_logging_settings_arn => { kind: :property, name: "userAccessLoggingSettingsArn", is_optional: true },
    :user_settings_arn => { kind: :property, name: "userSettingsArn", 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.



508
509
510
511
 
# File 'workspaces_web/cfn_portal.rb', line 508

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:



520
521
522
523
 
# File 'workspaces_web/cfn_portal.rb', line 520

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:



530
531
532
533
 
# File 'workspaces_web/cfn_portal.rb', line 530

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:



541
542
543
544
545
 
# File 'workspaces_web/cfn_portal.rb', line 541

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.


598
599
600
601
602
 
# File 'workspaces_web/cfn_portal.rb', line 598

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.



608
609
610
611
 
# File 'workspaces_web/cfn_portal.rb', line 608

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.



620
621
622
623
624
 
# File 'workspaces_web/cfn_portal.rb', line 620

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

Returns:



282
283
284
 
# File 'workspaces_web/cfn_portal.rb', line 282

def additional_encryption_context()
  jsii_get_property("additionalEncryptionContext")
end

#additional_encryption_context=(value) ⇒ Object 



286
287
288
289
 
# File 'workspaces_web/cfn_portal.rb', line 286

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:



633
634
635
636
 
# File 'workspaces_web/cfn_portal.rb', line 633

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:



655
656
657
658
659
660
 
# File 'workspaces_web/cfn_portal.rb', line 655

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_browser_type ⇒ String

The browser that users see when using a streaming session.

Returns:

  • (String) 


212
213
214
 
# File 'workspaces_web/cfn_portal.rb', line 212

def attr_browser_type()
  jsii_get_property("attrBrowserType")
end

#attr_creation_date ⇒ String

The creation date of the web portal.

Returns:

  • (String) 


219
220
221
 
# File 'workspaces_web/cfn_portal.rb', line 219

def attr_creation_date()
  jsii_get_property("attrCreationDate")
end

#attr_portal_arn ⇒ String

The ARN of the web portal.

Returns:

  • (String) 


226
227
228
 
# File 'workspaces_web/cfn_portal.rb', line 226

def attr_portal_arn()
  jsii_get_property("attrPortalArn")
end

#attr_portal_endpoint ⇒ String

The endpoint URL of the web portal that users access in order to start streaming sessions.

Returns:

  • (String) 


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

def attr_portal_endpoint()
  jsii_get_property("attrPortalEndpoint")
end

#attr_portal_status ⇒ String

The status of the web portal.

Returns:

  • (String) 


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

def attr_portal_status()
  jsii_get_property("attrPortalStatus")
end

#attr_renderer_type ⇒ String

The renderer that is used in streaming sessions.

Returns:

  • (String) 


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

def attr_renderer_type()
  jsii_get_property("attrRendererType")
end

#attr_service_provider_saml_metadata ⇒ String

The SAML metadata of the service provider.

Returns:

  • (String) 


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

def attr_service_provider_saml_metadata()
  jsii_get_property("attrServiceProviderSamlMetadata")
end

#attr_status_reason ⇒ String

A message that explains why the web portal is in its current status.

Returns:

  • (String) 


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

def attr_status_reason()
  jsii_get_property("attrStatusReason")
end

#authentication_type ⇒ String?

The type of authentication integration points used when signing into the web portal.

Defaults to Standard .

Returns:

  • (String, nil) 


296
297
298
 
# File 'workspaces_web/cfn_portal.rb', line 296

def authentication_type()
  jsii_get_property("authenticationType")
end

#authentication_type=(value) ⇒ Object 



300
301
302
303
 
# File 'workspaces_web/cfn_portal.rb', line 300

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

#browser_settings_arn ⇒ String?

The ARN of the browser settings that is associated with this web portal.

Returns:

  • (String, nil) 


308
309
310
 
# File 'workspaces_web/cfn_portal.rb', line 308

def browser_settings_arn()
  jsii_get_property("browserSettingsArn")
end

#browser_settings_arn=(value) ⇒ Object 



312
313
314
315
 
# File 'workspaces_web/cfn_portal.rb', line 312

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



268
269
270
 
# File 'workspaces_web/cfn_portal.rb', line 268

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'workspaces_web/cfn_portal.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'workspaces_web/cfn_portal.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


664
665
666
667
 
# File 'workspaces_web/cfn_portal.rb', line 664

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}) 


168
169
170
 
# File 'workspaces_web/cfn_portal.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'workspaces_web/cfn_portal.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'workspaces_web/cfn_portal.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#customer_managed_key ⇒ String?

The customer managed key of the web portal.

Returns:

  • (String, nil) 


320
321
322
 
# File 'workspaces_web/cfn_portal.rb', line 320

def customer_managed_key()
  jsii_get_property("customerManagedKey")
end

#customer_managed_key=(value) ⇒ Object 



324
325
326
327
 
# File 'workspaces_web/cfn_portal.rb', line 324

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

#data_protection_settings_arn ⇒ String?

The ARN of the data protection settings.

Returns:

  • (String, nil) 


332
333
334
 
# File 'workspaces_web/cfn_portal.rb', line 332

def data_protection_settings_arn()
  jsii_get_property("dataProtectionSettingsArn")
end

#data_protection_settings_arn=(value) ⇒ Object 



336
337
338
339
 
# File 'workspaces_web/cfn_portal.rb', line 336

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

#display_name ⇒ String?

The name of the web portal.

Returns:

  • (String, nil) 


344
345
346
 
# File 'workspaces_web/cfn_portal.rb', line 344

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



348
349
350
351
 
# File 'workspaces_web/cfn_portal.rb', line 348

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'workspaces_web/cfn_portal.rb', line 180

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:



677
678
679
680
681
 
# File 'workspaces_web/cfn_portal.rb', line 677

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:



688
689
690
691
 
# File 'workspaces_web/cfn_portal.rb', line 688

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



758
759
760
761
 
# File 'workspaces_web/cfn_portal.rb', line 758

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

#instance_type ⇒ String?

The type and resources of the underlying instance.

Returns:

  • (String, nil) 


356
357
358
 
# File 'workspaces_web/cfn_portal.rb', line 356

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



360
361
362
363
 
# File 'workspaces_web/cfn_portal.rb', line 360

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

#ip_access_settings_arn ⇒ String?

The ARN of the IP access settings that is associated with the web portal.

Returns:

  • (String, nil) 


368
369
370
 
# File 'workspaces_web/cfn_portal.rb', line 368

def ip_access_settings_arn()
  jsii_get_property("ipAccessSettingsArn")
end

#ip_access_settings_arn=(value) ⇒ Object 



372
373
374
375
 
# File 'workspaces_web/cfn_portal.rb', line 372

def ip_access_settings_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAccessSettingsArn") unless value.nil?
  jsii_set_property("ipAccessSettingsArn", value)
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) 


132
133
134
 
# File 'workspaces_web/cfn_portal.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#max_concurrent_sessions ⇒ Numeric?

The maximum number of concurrent sessions for the portal.

Returns:

  • (Numeric, nil) 


380
381
382
 
# File 'workspaces_web/cfn_portal.rb', line 380

def max_concurrent_sessions()
  jsii_get_property("maxConcurrentSessions")
end

#max_concurrent_sessions=(value) ⇒ Object 



384
385
386
387
 
# File 'workspaces_web/cfn_portal.rb', line 384

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

#network_settings_arn ⇒ String?

The ARN of the network settings that is associated with the web portal.

Returns:

  • (String, nil) 


392
393
394
 
# File 'workspaces_web/cfn_portal.rb', line 392

def network_settings_arn()
  jsii_get_property("networkSettingsArn")
end

#network_settings_arn=(value) ⇒ Object 



396
397
398
399
 
# File 'workspaces_web/cfn_portal.rb', line 396

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


115
116
117
 
# File 'workspaces_web/cfn_portal.rb', line 115

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:



699
700
701
 
# File 'workspaces_web/cfn_portal.rb', line 699

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:



706
707
708
 
# File 'workspaces_web/cfn_portal.rb', line 706

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.



499
500
501
502
 
# File 'workspaces_web/cfn_portal.rb', line 499

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

#portal_custom_domain ⇒ String?

Returns:

  • (String, nil) 


402
403
404
 
# File 'workspaces_web/cfn_portal.rb', line 402

def portal_custom_domain()
  jsii_get_property("portalCustomDomain")
end

#portal_custom_domain=(value) ⇒ Object 



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

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

#portal_ref ⇒ AWSCDK::Interfaces::AWSWorkspacesweb::PortalReference

A reference to a Portal resource.

Returns:



275
276
277
 
# File 'workspaces_web/cfn_portal.rb', line 275

def portal_ref()
  jsii_get_property("portalRef")
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) 


151
152
153
 
# File 'workspaces_web/cfn_portal.rb', line 151

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:



717
718
719
720
 
# File 'workspaces_web/cfn_portal.rb', line 717

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}) 


724
725
726
727
 
# File 'workspaces_web/cfn_portal.rb', line 724

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:



734
735
736
737
738
 
# File 'workspaces_web/cfn_portal.rb', line 734

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

#session_logger_arn ⇒ String?

The ARN of the session logger that is associated with the portal.

Returns:

  • (String, nil) 


414
415
416
 
# File 'workspaces_web/cfn_portal.rb', line 414

def session_logger_arn()
  jsii_get_property("sessionLoggerArn")
end

#session_logger_arn=(value) ⇒ Object 



418
419
420
421
 
# File 'workspaces_web/cfn_portal.rb', line 418

def session_logger_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sessionLoggerArn") unless value.nil?
  jsii_set_property("sessionLoggerArn", value)
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.



743
744
745
 
# File 'workspaces_web/cfn_portal.rb', line 743

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:



141
142
143
 
# File 'workspaces_web/cfn_portal.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags to add to the web portal.

Returns:



426
427
428
 
# File 'workspaces_web/cfn_portal.rb', line 426

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



430
431
432
433
434
 
# File 'workspaces_web/cfn_portal.rb', line 430

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



475
476
477
 
# File 'workspaces_web/cfn_portal.rb', line 475

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

#trust_store_arn ⇒ String?

The ARN of the trust store that is associated with the web portal.

Returns:

  • (String, nil) 


439
440
441
 
# File 'workspaces_web/cfn_portal.rb', line 439

def trust_store_arn()
  jsii_get_property("trustStoreArn")
end

#trust_store_arn=(value) ⇒ Object 



443
444
445
446
 
# File 'workspaces_web/cfn_portal.rb', line 443

def trust_store_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trustStoreArn") unless value.nil?
  jsii_set_property("trustStoreArn", 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}) 


188
189
190
 
# File 'workspaces_web/cfn_portal.rb', line 188

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}) 


198
199
200
 
# File 'workspaces_web/cfn_portal.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_access_logging_settings_arn ⇒ String?

The ARN of the user access logging settings that is associated with the web portal.

Returns:

  • (String, nil) 


451
452
453
 
# File 'workspaces_web/cfn_portal.rb', line 451

def user_access_logging_settings_arn()
  jsii_get_property("userAccessLoggingSettingsArn")
end

#user_access_logging_settings_arn=(value) ⇒ Object 



455
456
457
458
 
# File 'workspaces_web/cfn_portal.rb', line 455

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

#user_settings_arn ⇒ String?

The ARN of the user settings that is associated with the web portal.

Returns:

  • (String, nil) 


463
464
465
 
# File 'workspaces_web/cfn_portal.rb', line 463

def ()
  jsii_get_property("userSettingsArn")
end

#user_settings_arn=(value) ⇒ Object 



467
468
469
470
 
# File 'workspaces_web/cfn_portal.rb', line 467

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


749
750
751
752
 
# File 'workspaces_web/cfn_portal.rb', line 749

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


488
489
490
491
492
493
 
# File 'workspaces_web/cfn_portal.rb', line 488

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