Class: AWSCDK::Workspaces::CfnWorkspacesPool

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSWorkspaces::IWorkspacesPoolRef
Defined in:
workspaces/cfn_workspaces_pool.rb

Overview

Describes a pool of WorkSpaces.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnWorkspacesPool

Create a new AWS::WorkSpaces::WorkspacesPool.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Workspaces::CfnWorkspacesPoolProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'workspaces/cfn_workspaces_pool.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPoolProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd29ya3NwYWNlcy5DZm5Xb3Jrc3BhY2VzUG9vbFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_workspaces_pool(resource) ⇒ String

Parameters:

Returns:

  • (String) 


82
83
84
85
 
# File 'workspaces/cfn_workspaces_pool.rb', line 82

def self.arn_for_workspaces_pool(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c193b3Jrc3BhY2VzLklXb3Jrc3BhY2VzUG9vbFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspaces.CfnWorkspacesPool", "arnForWorkspacesPool", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


215
216
217
 
# File 'workspaces/cfn_workspaces_pool.rb', line 215

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

.from_pool_id(scope, id, pool_id) ⇒ AWSCDK::Interfaces::AWSWorkspaces::IWorkspacesPoolRef

Creates a new IWorkspacesPoolRef from a poolId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • pool_id (String)

Returns:



93
94
95
96
97
98
 
# File 'workspaces/cfn_workspaces_pool.rb', line 93

def self.from_pool_id(scope, id, pool_id)
  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(pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "poolId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspaces.CfnWorkspacesPool", "fromPoolId", [scope, id, pool_id])
end

.from_workspaces_pool_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSWorkspaces::IWorkspacesPoolRef

Creates a new IWorkspacesPoolRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



106
107
108
109
110
111
 
# File 'workspaces/cfn_workspaces_pool.rb', line 106

def self.from_workspaces_pool_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspaces.CfnWorkspacesPool", "fromWorkspacesPoolArn", [scope, id, arn])
end

.is_cfn_workspaces_pool(x) ⇒ Boolean

Checks whether the given object is a CfnWorkspacesPool.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


117
118
119
120
 
# File 'workspaces/cfn_workspaces_pool.rb', line 117

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

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'workspaces/cfn_workspaces_pool.rb', line 26

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_pool_arn => { kind: :property, name: "attrPoolArn", is_optional: false },
    :attr_pool_id => { kind: :property, name: "attrPoolId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :workspaces_pool_ref => { kind: :property, name: "workspacesPoolRef", is_optional: false },
    :bundle_id => { kind: :property, name: "bundleId", is_optional: false },
    :capacity => { kind: :property, name: "capacity", is_optional: false },
    :directory_id => { kind: :property, name: "directoryId", is_optional: false },
    :pool_name => { kind: :property, name: "poolName", is_optional: false },
    :application_settings => { kind: :property, name: "applicationSettings", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :running_mode => { kind: :property, name: "runningMode", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :timeout_settings => { kind: :property, name: "timeoutSettings", 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.



401
402
403
404
 
# File 'workspaces/cfn_workspaces_pool.rb', line 401

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:



413
414
415
416
 
# File 'workspaces/cfn_workspaces_pool.rb', line 413

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:



423
424
425
426
 
# File 'workspaces/cfn_workspaces_pool.rb', line 423

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:



434
435
436
437
438
 
# File 'workspaces/cfn_workspaces_pool.rb', line 434

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.


491
492
493
494
495
 
# File 'workspaces/cfn_workspaces_pool.rb', line 491

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.



501
502
503
504
 
# File 'workspaces/cfn_workspaces_pool.rb', line 501

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.



513
514
515
516
517
 
# File 'workspaces/cfn_workspaces_pool.rb', line 513

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

#application_settings ⇒ AWSCDK::IResolvable, ...

The persistent application settings for users of the pool.

Returns:



306
307
308
 
# File 'workspaces/cfn_workspaces_pool.rb', line 306

def application_settings()
  jsii_get_property("applicationSettings")
end

#application_settings=(value) ⇒ Object 



310
311
312
313
314
 
# File 'workspaces/cfn_workspaces_pool.rb', line 310

def application_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPool::ApplicationSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzLkNmbldvcmtzcGFjZXNQb29sLkFwcGxpY2F0aW9uU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "applicationSettings") unless value.nil?
  jsii_set_property("applicationSettings", 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:



526
527
528
529
 
# File 'workspaces/cfn_workspaces_pool.rb', line 526

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:



548
549
550
551
552
553
 
# File 'workspaces/cfn_workspaces_pool.rb', line 548

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

The time the pool was created.

Returns:

  • (String) 


222
223
224
 
# File 'workspaces/cfn_workspaces_pool.rb', line 222

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_pool_arn ⇒ String

The Amazon Resource Name (ARN) for the pool.

Returns:

  • (String) 


229
230
231
 
# File 'workspaces/cfn_workspaces_pool.rb', line 229

def attr_pool_arn()
  jsii_get_property("attrPoolArn")
end

#attr_pool_id ⇒ String

The identifier of the pool.

Returns:

  • (String) 


236
237
238
 
# File 'workspaces/cfn_workspaces_pool.rb', line 236

def attr_pool_id()
  jsii_get_property("attrPoolId")
end

#bundle_id ⇒ String

The identifier of the bundle used by the pool.

Returns:

  • (String) 


257
258
259
 
# File 'workspaces/cfn_workspaces_pool.rb', line 257

def bundle_id()
  jsii_get_property("bundleId")
end

#bundle_id=(value) ⇒ Object 



261
262
263
264
 
# File 'workspaces/cfn_workspaces_pool.rb', line 261

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

#capacity ⇒ AWSCDK::IResolvable, AWSCDK::Workspaces::CfnWorkspacesPool::CapacityProperty

Describes the user capacity for the pool.

Returns:



269
270
271
 
# File 'workspaces/cfn_workspaces_pool.rb', line 269

def capacity()
  jsii_get_property("capacity")
end

#capacity=(value) ⇒ Object 



273
274
275
276
277
 
# File 'workspaces/cfn_workspaces_pool.rb', line 273

def capacity=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPool::CapacityProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzLkNmbldvcmtzcGFjZXNQb29sLkNhcGFjaXR5UHJvcGVydHkifV19fQ==")), "capacity")
  jsii_set_property("capacity", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



243
244
245
 
# File 'workspaces/cfn_workspaces_pool.rb', line 243

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



168
169
170
 
# File 'workspaces/cfn_workspaces_pool.rb', line 168

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'workspaces/cfn_workspaces_pool.rb', line 173

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


557
558
559
560
 
# File 'workspaces/cfn_workspaces_pool.rb', line 557

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


178
179
180
 
# File 'workspaces/cfn_workspaces_pool.rb', line 178

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


185
186
187
 
# File 'workspaces/cfn_workspaces_pool.rb', line 185

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


130
131
132
 
# File 'workspaces/cfn_workspaces_pool.rb', line 130

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the pool.

Returns:

  • (String, nil) 


319
320
321
 
# File 'workspaces/cfn_workspaces_pool.rb', line 319

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



323
324
325
326
 
# File 'workspaces/cfn_workspaces_pool.rb', line 323

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

#directory_id ⇒ String

The identifier of the directory used by the pool.

Returns:

  • (String) 


282
283
284
 
# File 'workspaces/cfn_workspaces_pool.rb', line 282

def directory_id()
  jsii_get_property("directoryId")
end

#directory_id=(value) ⇒ Object 



286
287
288
289
 
# File 'workspaces/cfn_workspaces_pool.rb', line 286

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



190
191
192
 
# File 'workspaces/cfn_workspaces_pool.rb', line 190

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:



570
571
572
573
574
 
# File 'workspaces/cfn_workspaces_pool.rb', line 570

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:



581
582
583
584
 
# File 'workspaces/cfn_workspaces_pool.rb', line 581

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:



651
652
653
654
 
# File 'workspaces/cfn_workspaces_pool.rb', line 651

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) 


142
143
144
 
# File 'workspaces/cfn_workspaces_pool.rb', line 142

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


125
126
127
 
# File 'workspaces/cfn_workspaces_pool.rb', line 125

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:



592
593
594
 
# File 'workspaces/cfn_workspaces_pool.rb', line 592

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:



599
600
601
 
# File 'workspaces/cfn_workspaces_pool.rb', line 599

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.



392
393
394
395
 
# File 'workspaces/cfn_workspaces_pool.rb', line 392

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

#pool_name ⇒ String

The name of the pool.

Returns:

  • (String) 


294
295
296
 
# File 'workspaces/cfn_workspaces_pool.rb', line 294

def pool_name()
  jsii_get_property("poolName")
end

#pool_name=(value) ⇒ Object 



298
299
300
301
 
# File 'workspaces/cfn_workspaces_pool.rb', line 298

def pool_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "poolName")
  jsii_set_property("poolName", 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) 


161
162
163
 
# File 'workspaces/cfn_workspaces_pool.rb', line 161

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:



610
611
612
613
 
# File 'workspaces/cfn_workspaces_pool.rb', line 610

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


617
618
619
620
 
# File 'workspaces/cfn_workspaces_pool.rb', line 617

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:



627
628
629
630
631
 
# File 'workspaces/cfn_workspaces_pool.rb', line 627

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

#running_mode ⇒ String?

The running mode of the pool.

Returns:

  • (String, nil) 


331
332
333
 
# File 'workspaces/cfn_workspaces_pool.rb', line 331

def running_mode()
  jsii_get_property("runningMode")
end

#running_mode=(value) ⇒ Object 



335
336
337
338
 
# File 'workspaces/cfn_workspaces_pool.rb', line 335

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



636
637
638
 
# File 'workspaces/cfn_workspaces_pool.rb', line 636

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:



151
152
153
 
# File 'workspaces/cfn_workspaces_pool.rb', line 151

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Deprecated.

this property has been deprecated

Returns:



342
343
344
 
# File 'workspaces/cfn_workspaces_pool.rb', line 342

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



346
347
348
349
350
 
# File 'workspaces/cfn_workspaces_pool.rb', line 346

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

#timeout_settings ⇒ AWSCDK::IResolvable, ...

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

Returns:



355
356
357
 
# File 'workspaces/cfn_workspaces_pool.rb', line 355

def timeout_settings()
  jsii_get_property("timeoutSettings")
end

#timeout_settings=(value) ⇒ Object 



359
360
361
362
363
 
# File 'workspaces/cfn_workspaces_pool.rb', line 359

def timeout_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Workspaces::CfnWorkspacesPool::TimeoutSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzLkNmbldvcmtzcGFjZXNQb29sLlRpbWVvdXRTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "timeoutSettings") unless value.nil?
  jsii_set_property("timeoutSettings", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



368
369
370
 
# File 'workspaces/cfn_workspaces_pool.rb', line 368

def to_string()
  jsii_call_method("toString", [])
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}) 


198
199
200
 
# File 'workspaces/cfn_workspaces_pool.rb', line 198

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


208
209
210
 
# File 'workspaces/cfn_workspaces_pool.rb', line 208

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


642
643
644
645
 
# File 'workspaces/cfn_workspaces_pool.rb', line 642

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) 


381
382
383
384
385
386
 
# File 'workspaces/cfn_workspaces_pool.rb', line 381

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

#workspaces_pool_ref ⇒ AWSCDK::Interfaces::AWSWorkspaces::WorkspacesPoolReference

A reference to a WorkspacesPool resource.

Returns:



250
251
252
 
# File 'workspaces/cfn_workspaces_pool.rb', line 250

def workspaces_pool_ref()
  jsii_get_property("workspacesPoolRef")
end