Class: AWSCDK::AppStream::CfnStackProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_stream/cfn_stack_props.rb

Overview

Properties for defining a CfnStack.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_endpoints: nil, application_settings: nil, attributes_to_delete: nil, content_redirection: nil, delete_storage_connectors: nil, description: nil, display_name: nil, embed_host_domains: nil, feedback_url: nil, name: nil, redirect_url: nil, storage_connectors: nil, streaming_experience_settings: nil, tags: nil, user_settings: nil) ⇒ CfnStackProps

Returns a new instance of CfnStackProps.

Parameters:



24
25
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
 
# File 'app_stream/cfn_stack_props.rb', line 24

def initialize(access_endpoints: nil, application_settings: nil, attributes_to_delete: nil, content_redirection: nil, delete_storage_connectors: nil, description: nil, display_name: nil, embed_host_domains: nil, feedback_url: nil, name: nil, redirect_url: nil, storage_connectors: nil, streaming_experience_settings: nil, tags: nil, user_settings: nil)
  @access_endpoints = access_endpoints
  Jsii::Type.check_type(@access_endpoints, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3RyZWFtLkNmblN0YWNrLkFjY2Vzc0VuZHBvaW50UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "accessEndpoints") unless @access_endpoints.nil?
  @application_settings = application_settings.is_a?(Hash) ? ::AWSCDK::AppStream::CfnStack::ApplicationSettingsProperty.new(**application_settings.transform_keys(&:to_sym)) : application_settings
  Jsii::Type.check_type(@application_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuU3RhY2suQXBwbGljYXRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "applicationSettings") unless @application_settings.nil?
  @attributes_to_delete = attributes_to_delete
  Jsii::Type.check_type(@attributes_to_delete, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "attributesToDelete") unless @attributes_to_delete.nil?
  @content_redirection = content_redirection.is_a?(Hash) ? ::AWSCDK::AppStream::CfnStack::ContentRedirectionProperty.new(**content_redirection.transform_keys(&:to_sym)) : content_redirection
  Jsii::Type.check_type(@content_redirection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuU3RhY2suQ29udGVudFJlZGlyZWN0aW9uUHJvcGVydHkifV19fQ==")), "contentRedirection") unless @content_redirection.nil?
  @delete_storage_connectors = delete_storage_connectors
  Jsii::Type.check_type(@delete_storage_connectors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteStorageConnectors") unless @delete_storage_connectors.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @embed_host_domains = embed_host_domains
  Jsii::Type.check_type(@embed_host_domains, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "embedHostDomains") unless @embed_host_domains.nil?
  @feedback_url = feedback_url
  Jsii::Type.check_type(@feedback_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "feedbackUrl") unless @feedback_url.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @redirect_url = redirect_url
  Jsii::Type.check_type(@redirect_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "redirectUrl") unless @redirect_url.nil?
  @storage_connectors = storage_connectors
  Jsii::Type.check_type(@storage_connectors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3RyZWFtLkNmblN0YWNrLlN0b3JhZ2VDb25uZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "storageConnectors") unless @storage_connectors.nil?
  @streaming_experience_settings = streaming_experience_settings.is_a?(Hash) ? ::AWSCDK::AppStream::CfnStack::StreamingExperienceSettingsProperty.new(**streaming_experience_settings.transform_keys(&:to_sym)) : streaming_experience_settings
  Jsii::Type.check_type(@streaming_experience_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuU3RhY2suU3RyZWFtaW5nRXhwZXJpZW5jZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "streamingExperienceSettings") unless @streaming_experience_settings.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @user_settings = 
  Jsii::Type.check_type(@user_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3RyZWFtLkNmblN0YWNrLlVzZXJTZXR0aW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "userSettings") unless @user_settings.nil?
end

Instance Attribute Details

#access_endpoints ⇒ AWSCDK::IResolvable, ... (readonly)

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

Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.

Returns:

See Also:



63
64
65
 
# File 'app_stream/cfn_stack_props.rb', line 63

def access_endpoints
  @access_endpoints
end

#application_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The persistent application settings for users of the stack.

When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

Returns:

See Also:



70
71
72
 
# File 'app_stream/cfn_stack_props.rb', line 70

def application_settings
  @application_settings
end

#attributes_to_delete ⇒ Array<String>? (readonly)

The stack attributes to delete.

Returns:

  • (Array<String>, nil)

See Also:



75
76
77
 
# File 'app_stream/cfn_stack_props.rb', line 75

def attributes_to_delete
  @attributes_to_delete
end

#content_redirection ⇒ AWSCDK::IResolvable, ... (readonly)

The content redirection settings for the stack.

Returns:

See Also:



80
81
82
 
# File 'app_stream/cfn_stack_props.rb', line 80

def content_redirection
  @content_redirection
end

#delete_storage_connectors ⇒ Boolean, ... (readonly)

This parameter has been deprecated..

Deletes the storage connectors currently enabled for the stack.

Returns:

See Also:



87
88
89
 
# File 'app_stream/cfn_stack_props.rb', line 87

def delete_storage_connectors
  @delete_storage_connectors
end

#description ⇒ String? (readonly)

The description to display.

Returns:

  • (String, nil)

See Also:



92
93
94
 
# File 'app_stream/cfn_stack_props.rb', line 92

def description
  @description
end

#display_name ⇒ String? (readonly)

The stack name to display.

Returns:

  • (String, nil)

See Also:



97
98
99
 
# File 'app_stream/cfn_stack_props.rb', line 97

def display_name
  @display_name
end

#embed_host_domains ⇒ Array<String>? (readonly)

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

You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.

Returns:

  • (Array<String>, nil)

See Also:



104
105
106
 
# File 'app_stream/cfn_stack_props.rb', line 104

def embed_host_domains
  @embed_host_domains
end

#feedback_url ⇒ String? (readonly)

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

If no URL is specified, no Send Feedback link is displayed.

Returns:

  • (String, nil)

See Also:



111
112
113
 
# File 'app_stream/cfn_stack_props.rb', line 111

def feedback_url
  @feedback_url
end

#name ⇒ String? (readonly)

The name of the stack.

Returns:

  • (String, nil)

See Also:



116
117
118
 
# File 'app_stream/cfn_stack_props.rb', line 116

def name
  @name
end

#redirect_url ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



121
122
123
 
# File 'app_stream/cfn_stack_props.rb', line 121

def redirect_url
  @redirect_url
end

#storage_connectors ⇒ AWSCDK::IResolvable, ... (readonly)

The storage connectors to enable.

Returns:

See Also:



126
127
128
 
# File 'app_stream/cfn_stack_props.rb', line 126

def storage_connectors
  @storage_connectors
end

#streaming_experience_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The streaming protocol that you want your stack to prefer.

This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

Returns:

See Also:



133
134
135
 
# File 'app_stream/cfn_stack_props.rb', line 133

def streaming_experience_settings
  @streaming_experience_settings
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs.

Returns:

See Also:



138
139
140
 
# File 'app_stream/cfn_stack_props.rb', line 138

def tags
  @tags
end

#user_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

By default, these actions are enabled.

Returns:

See Also:



145
146
147
 
# File 'app_stream/cfn_stack_props.rb', line 145

def 
  @user_settings
end

Class Method Details

.jsii_properties ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'app_stream/cfn_stack_props.rb', line 147

def self.jsii_properties
  {
    :access_endpoints => "accessEndpoints",
    :application_settings => "applicationSettings",
    :attributes_to_delete => "attributesToDelete",
    :content_redirection => "contentRedirection",
    :delete_storage_connectors => "deleteStorageConnectors",
    :description => "description",
    :display_name => "displayName",
    :embed_host_domains => "embedHostDomains",
    :feedback_url => "feedbackUrl",
    :name => "name",
    :redirect_url => "redirectUrl",
    :storage_connectors => "storageConnectors",
    :streaming_experience_settings => "streamingExperienceSettings",
    :tags => "tags",
    :user_settings => "userSettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'app_stream/cfn_stack_props.rb', line 167

def to_jsii
  result = {}
  result.merge!({
    "accessEndpoints" => @access_endpoints,
    "applicationSettings" => @application_settings,
    "attributesToDelete" => @attributes_to_delete,
    "contentRedirection" => @content_redirection,
    "deleteStorageConnectors" => @delete_storage_connectors,
    "description" => @description,
    "displayName" => @display_name,
    "embedHostDomains" => @embed_host_domains,
    "feedbackUrl" => @feedback_url,
    "name" => @name,
    "redirectUrl" => @redirect_url,
    "storageConnectors" => @storage_connectors,
    "streamingExperienceSettings" => @streaming_experience_settings,
    "tags" => @tags,
    "userSettings" => @user_settings,
  })
  result.compact
end