Class: AWSCDK::AppStream::CfnStack

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSAppstream::IStackRef
Defined in:
app_stream/cfn_stack.rb

Overview

The AWS::AppStream::Stack resource creates a stack to start streaming applications to Amazon AppStream 2.0 users. A stack consists of an associated fleet, user access policies, and storage configurations.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::AppStream::Stack.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::AppStream::CfnStackProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'app_stream/cfn_stack.rb', line 18

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

Class Method Details

.arn_for_stack(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'app_stream/cfn_stack.rb', line 85

def self.arn_for_stack(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBzdHJlYW0uSVN0YWNrUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnStack", "arnForStack", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


205
206
207
 
# File 'app_stream/cfn_stack.rb', line 205

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

.from_stack_name(scope, id, stack_name) ⇒ AWSCDK::Interfaces::AWSAppstream::IStackRef

Creates a new IStackRef from a stackName.

Parameters:

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

Returns:



96
97
98
99
100
101
 
# File 'app_stream/cfn_stack.rb', line 96

def self.from_stack_name(scope, id, stack_name)
  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(stack_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnStack", "fromStackName", [scope, id, stack_name])
end

.is_cfn_stack(x) ⇒ Boolean

Checks whether the given object is a CfnStack.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'app_stream/cfn_stack.rb', line 107

def self.is_cfn_stack(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnStack", "isCfnStack", [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
 
# File 'app_stream/cfn_stack.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 },
    :stack_ref => { kind: :property, name: "stackRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :access_endpoints => { kind: :property, name: "accessEndpoints", is_optional: true },
    :application_settings => { kind: :property, name: "applicationSettings", is_optional: true },
    :attributes_to_delete => { kind: :property, name: "attributesToDelete", is_optional: true },
    :content_redirection => { kind: :property, name: "contentRedirection", is_optional: true },
    :delete_storage_connectors => { kind: :property, name: "deleteStorageConnectors", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :embed_host_domains => { kind: :property, name: "embedHostDomains", is_optional: true },
    :feedback_url => { kind: :property, name: "feedbackUrl", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :redirect_url => { kind: :property, name: "redirectUrl", is_optional: true },
    :storage_connectors => { kind: :property, name: "storageConnectors", is_optional: true },
    :streaming_experience_settings => { kind: :property, name: "streamingExperienceSettings", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :user_settings => { kind: :property, name: "userSettings", 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

#access_endpoints ⇒ AWSCDK::IResolvable, ...

The list of virtual private cloud (VPC) interface endpoint objects.

Returns:



226
227
228
 
# File 'app_stream/cfn_stack.rb', line 226

def access_endpoints()
  jsii_get_property("accessEndpoints")
end

#access_endpoints=(value) ⇒ Object 



230
231
232
233
 
# File 'app_stream/cfn_stack.rb', line 230

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

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



443
444
445
446
 
# File 'app_stream/cfn_stack.rb', line 443

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:



455
456
457
458
 
# File 'app_stream/cfn_stack.rb', line 455

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:



465
466
467
468
 
# File 'app_stream/cfn_stack.rb', line 465

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:



476
477
478
479
480
 
# File 'app_stream/cfn_stack.rb', line 476

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.


533
534
535
536
537
 
# File 'app_stream/cfn_stack.rb', line 533

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.



543
544
545
546
 
# File 'app_stream/cfn_stack.rb', line 543

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.



555
556
557
558
559
 
# File 'app_stream/cfn_stack.rb', line 555

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

Returns:



238
239
240
 
# File 'app_stream/cfn_stack.rb', line 238

def application_settings()
  jsii_get_property("applicationSettings")
end

#application_settings=(value) ⇒ Object 



242
243
244
245
246
 
# File 'app_stream/cfn_stack.rb', line 242

def application_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnStack::ApplicationSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuU3RhY2suQXBwbGljYXRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "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:



568
569
570
571
 
# File 'app_stream/cfn_stack.rb', line 568

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:



590
591
592
593
594
595
 
# File 'app_stream/cfn_stack.rb', line 590

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

#attributes_to_delete ⇒ Array<String>?

The stack attributes to delete.

Returns:

  • (Array<String>, nil) 


251
252
253
 
# File 'app_stream/cfn_stack.rb', line 251

def attributes_to_delete()
  jsii_get_property("attributesToDelete")
end

#attributes_to_delete=(value) ⇒ Object 



255
256
257
258
 
# File 'app_stream/cfn_stack.rb', line 255

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'app_stream/cfn_stack.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'app_stream/cfn_stack.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) 


599
600
601
602
 
# File 'app_stream/cfn_stack.rb', line 599

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 'app_stream/cfn_stack.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 'app_stream/cfn_stack.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#content_redirection ⇒ AWSCDK::IResolvable, ...

The content redirection settings for the stack.

Returns:



263
264
265
 
# File 'app_stream/cfn_stack.rb', line 263

def content_redirection()
  jsii_get_property("contentRedirection")
end

#content_redirection=(value) ⇒ Object 



267
268
269
270
271
 
# File 'app_stream/cfn_stack.rb', line 267

def content_redirection=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnStack::ContentRedirectionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuU3RhY2suQ29udGVudFJlZGlyZWN0aW9uUHJvcGVydHkifV19fQ==")), "contentRedirection") unless value.nil?
  jsii_set_property("contentRedirection", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'app_stream/cfn_stack.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#delete_storage_connectors ⇒ Boolean, ...

This parameter has been deprecated..

Returns:



276
277
278
 
# File 'app_stream/cfn_stack.rb', line 276

def delete_storage_connectors()
  jsii_get_property("deleteStorageConnectors")
end

#delete_storage_connectors=(value) ⇒ Object 



280
281
282
283
 
# File 'app_stream/cfn_stack.rb', line 280

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

#description ⇒ String?

The description to display.

Returns:

  • (String, nil) 


288
289
290
 
# File 'app_stream/cfn_stack.rb', line 288

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



292
293
294
295
 
# File 'app_stream/cfn_stack.rb', line 292

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

#display_name ⇒ String?

The stack name to display.

Returns:

  • (String, nil) 


300
301
302
 
# File 'app_stream/cfn_stack.rb', line 300

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



304
305
306
307
 
# File 'app_stream/cfn_stack.rb', line 304

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

#embed_host_domains ⇒ Array<String>?

The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe.

Returns:

  • (Array<String>, nil) 


312
313
314
 
# File 'app_stream/cfn_stack.rb', line 312

def embed_host_domains()
  jsii_get_property("embedHostDomains")
end

#embed_host_domains=(value) ⇒ Object 



316
317
318
319
 
# File 'app_stream/cfn_stack.rb', line 316

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'app_stream/cfn_stack.rb', line 180

def env()
  jsii_get_property("env")
end

#feedback_url ⇒ String?

The URL that users are redirected to after they click the Send Feedback link.

Returns:

  • (String, nil) 


324
325
326
 
# File 'app_stream/cfn_stack.rb', line 324

def feedback_url()
  jsii_get_property("feedbackUrl")
end

#feedback_url=(value) ⇒ Object 



328
329
330
331
 
# File 'app_stream/cfn_stack.rb', line 328

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



612
613
614
615
616
 
# File 'app_stream/cfn_stack.rb', line 612

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:



623
624
625
626
 
# File 'app_stream/cfn_stack.rb', line 623

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:



693
694
695
696
 
# File 'app_stream/cfn_stack.rb', line 693

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) 


132
133
134
 
# File 'app_stream/cfn_stack.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the stack.

Returns:

  • (String, nil) 


336
337
338
 
# File 'app_stream/cfn_stack.rb', line 336

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



340
341
342
343
 
# File 'app_stream/cfn_stack.rb', line 340

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) 


115
116
117
 
# File 'app_stream/cfn_stack.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:



634
635
636
 
# File 'app_stream/cfn_stack.rb', line 634

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:



641
642
643
 
# File 'app_stream/cfn_stack.rb', line 641

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.



434
435
436
437
 
# File 'app_stream/cfn_stack.rb', line 434

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

#redirect_url ⇒ String?

The URL that users are redirected to after their streaming session ends.

Returns:

  • (String, nil) 


348
349
350
 
# File 'app_stream/cfn_stack.rb', line 348

def redirect_url()
  jsii_get_property("redirectUrl")
end

#redirect_url=(value) ⇒ Object 



352
353
354
355
 
# File 'app_stream/cfn_stack.rb', line 352

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


151
152
153
 
# File 'app_stream/cfn_stack.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:



652
653
654
655
 
# File 'app_stream/cfn_stack.rb', line 652

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


659
660
661
662
 
# File 'app_stream/cfn_stack.rb', line 659

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:



669
670
671
672
673
 
# File 'app_stream/cfn_stack.rb', line 669

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.



678
679
680
 
# File 'app_stream/cfn_stack.rb', line 678

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 'app_stream/cfn_stack.rb', line 141

def stack()
  jsii_get_property("stack")
end

#stack_ref ⇒ AWSCDK::Interfaces::AWSAppstream::StackReference

A reference to a Stack resource.

Returns:



212
213
214
 
# File 'app_stream/cfn_stack.rb', line 212

def stack_ref()
  jsii_get_property("stackRef")
end

#storage_connectors ⇒ AWSCDK::IResolvable, ...

The storage connectors to enable.

Returns:



360
361
362
 
# File 'app_stream/cfn_stack.rb', line 360

def storage_connectors()
  jsii_get_property("storageConnectors")
end

#storage_connectors=(value) ⇒ Object 



364
365
366
367
 
# File 'app_stream/cfn_stack.rb', line 364

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

#streaming_experience_settings ⇒ AWSCDK::IResolvable, ...

The streaming protocol that you want your stack to prefer.

Returns:



372
373
374
 
# File 'app_stream/cfn_stack.rb', line 372

def streaming_experience_settings()
  jsii_get_property("streamingExperienceSettings")
end

#streaming_experience_settings=(value) ⇒ Object 



376
377
378
379
380
 
# File 'app_stream/cfn_stack.rb', line 376

def streaming_experience_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnStack::StreamingExperienceSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuU3RhY2suU3RyZWFtaW5nRXhwZXJpZW5jZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "streamingExperienceSettings") unless value.nil?
  jsii_set_property("streamingExperienceSettings", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



219
220
221
 
# File 'app_stream/cfn_stack.rb', line 219

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs.

Returns:



385
386
387
 
# File 'app_stream/cfn_stack.rb', line 385

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



389
390
391
392
393
 
# File 'app_stream/cfn_stack.rb', line 389

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



410
411
412
 
# File 'app_stream/cfn_stack.rb', line 410

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


188
189
190
 
# File 'app_stream/cfn_stack.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 'app_stream/cfn_stack.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_settings ⇒ AWSCDK::IResolvable, ...

The actions that are enabled or disabled for users during their streaming sessions.

Returns:



398
399
400
 
# File 'app_stream/cfn_stack.rb', line 398

def ()
  jsii_get_property("userSettings")
end

#user_settings=(value) ⇒ Object 



402
403
404
405
 
# File 'app_stream/cfn_stack.rb', line 402

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


684
685
686
687
 
# File 'app_stream/cfn_stack.rb', line 684

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) 


423
424
425
426
427
428
 
# File 'app_stream/cfn_stack.rb', line 423

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