Class: AWSCDK::WorkspacesThinClient::CfnEnvironment

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSWorkspacesthinclient::IEnvironmentRef
Defined in:
workspaces_thin_client/cfn_environment.rb

Overview

Describes an environment.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEnvironment

Create a new AWS::WorkSpacesThinClient::Environment.

Parameters:



18
19
20
21
22
23
24
 
# File 'workspaces_thin_client/cfn_environment.rb', line 18

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

Class Method Details

.arn_for_environment(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'workspaces_thin_client/cfn_environment.rb', line 90

def self.arn_for_environment(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c193b3Jrc3BhY2VzdGhpbmNsaWVudC5JRW52aXJvbm1lbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspacesthinclient.CfnEnvironment", "arnForEnvironment", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


223
224
225
 
# File 'workspaces_thin_client/cfn_environment.rb', line 223

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

.from_environment_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSWorkspacesthinclient::IEnvironmentRef

Creates a new IEnvironmentRef from an ARN.

Parameters:

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

Returns:



101
102
103
104
105
106
 
# File 'workspaces_thin_client/cfn_environment.rb', line 101

def self.from_environment_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_workspacesthinclient.CfnEnvironment", "fromEnvironmentArn", [scope, id, arn])
end

.from_environment_id(scope, id, environment_id) ⇒ AWSCDK::Interfaces::AWSWorkspacesthinclient::IEnvironmentRef

Creates a new IEnvironmentRef from a environmentId.

Parameters:

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

Returns:



114
115
116
117
118
119
 
# File 'workspaces_thin_client/cfn_environment.rb', line 114

def self.from_environment_id(scope, id, environment_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(environment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspacesthinclient.CfnEnvironment", "fromEnvironmentId", [scope, id, environment_id])
end

.is_cfn_environment(x) ⇒ Boolean

Checks whether the given object is a CfnEnvironment.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


125
126
127
128
 
# File 'workspaces_thin_client/cfn_environment.rb', line 125

def self.is_cfn_environment(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_workspacesthinclient.CfnEnvironment", "isCfnEnvironment", [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
79
80
81
82
83
84
85
86
 
# File 'workspaces_thin_client/cfn_environment.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_activation_code => { kind: :property, name: "attrActivationCode", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_desktop_type => { kind: :property, name: "attrDesktopType", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_pending_software_set_id => { kind: :property, name: "attrPendingSoftwareSetId", is_optional: false },
    :attr_pending_software_set_version => { kind: :property, name: "attrPendingSoftwareSetVersion", is_optional: false },
    :attr_registered_devices_count => { kind: :property, name: "attrRegisteredDevicesCount", is_optional: false },
    :attr_software_set_compliance_status => { kind: :property, name: "attrSoftwareSetComplianceStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :environment_ref => { kind: :property, name: "environmentRef", is_optional: false },
    :desktop_arn => { kind: :property, name: "desktopArn", is_optional: false },
    :desired_software_set_id => { kind: :property, name: "desiredSoftwareSetId", is_optional: true },
    :desktop_endpoint => { kind: :property, name: "desktopEndpoint", is_optional: true },
    :device_creation_tags => { kind: :property, name: "deviceCreationTags", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :maintenance_window => { kind: :property, name: "maintenanceWindow", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :software_set_update_mode => { kind: :property, name: "softwareSetUpdateMode", is_optional: true },
    :software_set_update_schedule => { kind: :property, name: "softwareSetUpdateSchedule", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



469
470
471
472
 
# File 'workspaces_thin_client/cfn_environment.rb', line 469

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:



481
482
483
484
 
# File 'workspaces_thin_client/cfn_environment.rb', line 481

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:



491
492
493
494
 
# File 'workspaces_thin_client/cfn_environment.rb', line 491

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:



502
503
504
505
506
 
# File 'workspaces_thin_client/cfn_environment.rb', line 502

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.


559
560
561
562
563
 
# File 'workspaces_thin_client/cfn_environment.rb', line 559

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.



569
570
571
572
 
# File 'workspaces_thin_client/cfn_environment.rb', line 569

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.



581
582
583
584
585
 
# File 'workspaces_thin_client/cfn_environment.rb', line 581

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

#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:



594
595
596
597
 
# File 'workspaces_thin_client/cfn_environment.rb', line 594

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:



616
617
618
619
620
621
 
# File 'workspaces_thin_client/cfn_environment.rb', line 616

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

The activation code to register a device to the environment.

Returns:

  • (String) 


230
231
232
 
# File 'workspaces_thin_client/cfn_environment.rb', line 230

def attr_activation_code()
  jsii_get_property("attrActivationCode")
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the environment.

Returns:

  • (String) 


237
238
239
 
# File 'workspaces_thin_client/cfn_environment.rb', line 237

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The timestamp of when the environment was created.

Returns:

  • (String) 


244
245
246
 
# File 'workspaces_thin_client/cfn_environment.rb', line 244

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_desktop_type ⇒ String

The type of streaming desktop for the environment.

Returns:

  • (String) 


251
252
253
 
# File 'workspaces_thin_client/cfn_environment.rb', line 251

def attr_desktop_type()
  jsii_get_property("attrDesktopType")
end

#attr_id ⇒ String

Unique identifier of the environment.

Returns:

  • (String) 


258
259
260
 
# File 'workspaces_thin_client/cfn_environment.rb', line 258

def attr_id()
  jsii_get_property("attrId")
end

#attr_pending_software_set_id ⇒ String

The ID of the software set that is pending to be installed.

Returns:

  • (String) 


265
266
267
 
# File 'workspaces_thin_client/cfn_environment.rb', line 265

def attr_pending_software_set_id()
  jsii_get_property("attrPendingSoftwareSetId")
end

#attr_pending_software_set_version ⇒ String

The version of the software set that is pending to be installed.

Returns:

  • (String) 


272
273
274
 
# File 'workspaces_thin_client/cfn_environment.rb', line 272

def attr_pending_software_set_version()
  jsii_get_property("attrPendingSoftwareSetVersion")
end

#attr_registered_devices_count ⇒ Numeric

The number of devices registered to the environment.

Returns:

  • (Numeric) 


279
280
281
 
# File 'workspaces_thin_client/cfn_environment.rb', line 279

def attr_registered_devices_count()
  jsii_get_property("attrRegisteredDevicesCount")
end

#attr_software_set_compliance_status ⇒ String

Describes if the software currently installed on all devices in the environment is a supported version.

Returns:

  • (String) 


286
287
288
 
# File 'workspaces_thin_client/cfn_environment.rb', line 286

def attr_software_set_compliance_status()
  jsii_get_property("attrSoftwareSetComplianceStatus")
end

#attr_updated_at ⇒ String

The timestamp of when the device was updated.

Returns:

  • (String) 


293
294
295
 
# File 'workspaces_thin_client/cfn_environment.rb', line 293

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



300
301
302
 
# File 'workspaces_thin_client/cfn_environment.rb', line 300

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



176
177
178
 
# File 'workspaces_thin_client/cfn_environment.rb', line 176

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'workspaces_thin_client/cfn_environment.rb', line 181

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


625
626
627
628
 
# File 'workspaces_thin_client/cfn_environment.rb', line 625

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


186
187
188
 
# File 'workspaces_thin_client/cfn_environment.rb', line 186

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


193
194
195
 
# File 'workspaces_thin_client/cfn_environment.rb', line 193

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


138
139
140
 
# File 'workspaces_thin_client/cfn_environment.rb', line 138

def creation_stack()
  jsii_get_property("creationStack")
end

#desired_software_set_id ⇒ String?

The ID of the software set to apply.

Returns:

  • (String, nil) 


326
327
328
 
# File 'workspaces_thin_client/cfn_environment.rb', line 326

def desired_software_set_id()
  jsii_get_property("desiredSoftwareSetId")
end

#desired_software_set_id=(value) ⇒ Object 



330
331
332
333
 
# File 'workspaces_thin_client/cfn_environment.rb', line 330

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

#desktop_arn ⇒ String

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or WorkSpaces Applications.

Returns:

  • (String) 


314
315
316
 
# File 'workspaces_thin_client/cfn_environment.rb', line 314

def desktop_arn()
  jsii_get_property("desktopArn")
end

#desktop_arn=(value) ⇒ Object 



318
319
320
321
 
# File 'workspaces_thin_client/cfn_environment.rb', line 318

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

#desktop_endpoint ⇒ String?

The URL for the identity provider login (only for environments that use WorkSpaces Applications).

Returns:

  • (String, nil) 


338
339
340
 
# File 'workspaces_thin_client/cfn_environment.rb', line 338

def desktop_endpoint()
  jsii_get_property("desktopEndpoint")
end

#desktop_endpoint=(value) ⇒ Object 



342
343
344
345
 
# File 'workspaces_thin_client/cfn_environment.rb', line 342

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

#device_creation_tags ⇒ AWSCDK::IResolvable, ...

An array of key-value pairs to apply to the newly created devices for this environment.

Returns:



350
351
352
 
# File 'workspaces_thin_client/cfn_environment.rb', line 350

def device_creation_tags()
  jsii_get_property("deviceCreationTags")
end

#device_creation_tags=(value) ⇒ Object 



354
355
356
357
 
# File 'workspaces_thin_client/cfn_environment.rb', line 354

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



198
199
200
 
# File 'workspaces_thin_client/cfn_environment.rb', line 198

def env()
  jsii_get_property("env")
end

#environment_ref ⇒ AWSCDK::Interfaces::AWSWorkspacesthinclient::EnvironmentReference

A reference to a Environment resource.

Returns:



307
308
309
 
# File 'workspaces_thin_client/cfn_environment.rb', line 307

def environment_ref()
  jsii_get_property("environmentRef")
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:



638
639
640
641
642
 
# File 'workspaces_thin_client/cfn_environment.rb', line 638

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:



649
650
651
652
 
# File 'workspaces_thin_client/cfn_environment.rb', line 649

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:



719
720
721
722
 
# File 'workspaces_thin_client/cfn_environment.rb', line 719

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

#kms_key_arn ⇒ String?

The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.

Returns:

  • (String, nil) 


362
363
364
 
# File 'workspaces_thin_client/cfn_environment.rb', line 362

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



366
367
368
369
 
# File 'workspaces_thin_client/cfn_environment.rb', line 366

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


150
151
152
 
# File 'workspaces_thin_client/cfn_environment.rb', line 150

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_window ⇒ AWSCDK::IResolvable, ...

A specification for a time window to apply software updates.

Returns:



374
375
376
 
# File 'workspaces_thin_client/cfn_environment.rb', line 374

def maintenance_window()
  jsii_get_property("maintenanceWindow")
end

#maintenance_window=(value) ⇒ Object 



378
379
380
381
382
 
# File 'workspaces_thin_client/cfn_environment.rb', line 378

def maintenance_window=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::WorkspacesThinClient::CfnEnvironment::MaintenanceWindowProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2VzdGhpbmNsaWVudC5DZm5FbnZpcm9ubWVudC5NYWludGVuYW5jZVdpbmRvd1Byb3BlcnR5In1dfX0=")), "maintenanceWindow") unless value.nil?
  jsii_set_property("maintenanceWindow", value)
end

#name ⇒ String?

The name of the environment.

Returns:

  • (String, nil) 


387
388
389
 
# File 'workspaces_thin_client/cfn_environment.rb', line 387

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



391
392
393
394
 
# File 'workspaces_thin_client/cfn_environment.rb', line 391

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


133
134
135
 
# File 'workspaces_thin_client/cfn_environment.rb', line 133

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:



660
661
662
 
# File 'workspaces_thin_client/cfn_environment.rb', line 660

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:



667
668
669
 
# File 'workspaces_thin_client/cfn_environment.rb', line 667

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.



460
461
462
463
 
# File 'workspaces_thin_client/cfn_environment.rb', line 460

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

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


169
170
171
 
# File 'workspaces_thin_client/cfn_environment.rb', line 169

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:



678
679
680
681
 
# File 'workspaces_thin_client/cfn_environment.rb', line 678

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


685
686
687
688
 
# File 'workspaces_thin_client/cfn_environment.rb', line 685

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:



695
696
697
698
699
 
# File 'workspaces_thin_client/cfn_environment.rb', line 695

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.



704
705
706
 
# File 'workspaces_thin_client/cfn_environment.rb', line 704

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

#software_set_update_mode ⇒ String?

An option to define which software updates to apply.

Returns:

  • (String, nil) 


399
400
401
 
# File 'workspaces_thin_client/cfn_environment.rb', line 399

def software_set_update_mode()
  jsii_get_property("softwareSetUpdateMode")
end

#software_set_update_mode=(value) ⇒ Object 



403
404
405
406
 
# File 'workspaces_thin_client/cfn_environment.rb', line 403

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

#software_set_update_schedule ⇒ String?

An option to define if software updates should be applied within a maintenance window.

Returns:

  • (String, nil) 


411
412
413
 
# File 'workspaces_thin_client/cfn_environment.rb', line 411

def software_set_update_schedule()
  jsii_get_property("softwareSetUpdateSchedule")
end

#software_set_update_schedule=(value) ⇒ Object 



415
416
417
418
 
# File 'workspaces_thin_client/cfn_environment.rb', line 415

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



159
160
161
 
# File 'workspaces_thin_client/cfn_environment.rb', line 159

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



423
424
425
 
# File 'workspaces_thin_client/cfn_environment.rb', line 423

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



427
428
429
430
431
 
# File 'workspaces_thin_client/cfn_environment.rb', line 427

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



436
437
438
 
# File 'workspaces_thin_client/cfn_environment.rb', line 436

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


206
207
208
 
# File 'workspaces_thin_client/cfn_environment.rb', line 206

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


216
217
218
 
# File 'workspaces_thin_client/cfn_environment.rb', line 216

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


710
711
712
713
 
# File 'workspaces_thin_client/cfn_environment.rb', line 710

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) 


449
450
451
452
453
454
 
# File 'workspaces_thin_client/cfn_environment.rb', line 449

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