Class: AWSCDK::QuickSight::CfnTheme

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSQuicksight::IThemeRef
Defined in:
quick_sight/cfn_theme.rb

Overview

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick in the Amazon Quick User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTheme

Create a new AWS::QuickSight::Theme.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::QuickSight::CfnThemeProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'quick_sight/cfn_theme.rb', line 20

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

Class Method Details

.arn_for_theme(resource) ⇒ String

Parameters:

Returns:

  • (String) 


97
98
99
100
 
# File 'quick_sight/cfn_theme.rb', line 97

def self.arn_for_theme(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xdWlja3NpZ2h0LklUaGVtZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnTheme", "arnForTheme", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


204
205
206
 
# File 'quick_sight/cfn_theme.rb', line 204

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

.is_cfn_theme(x) ⇒ Boolean

Checks whether the given object is a CfnTheme.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


106
107
108
109
 
# File 'quick_sight/cfn_theme.rb', line 106

def self.is_cfn_theme(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnTheme", "isCfnTheme", [x])
end

.jsii_overridable_methods ⇒ Object 



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
87
88
89
90
91
92
93
 
# File 'quick_sight/cfn_theme.rb', line 28

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_time => { kind: :property, name: "attrCreatedTime", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_type => { kind: :property, name: "attrType", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :attr_version_arn => { kind: :property, name: "attrVersionArn", is_optional: false },
    :attr_version_base_theme_id => { kind: :property, name: "attrVersionBaseThemeId", is_optional: false },
    :attr_version_configuration => { kind: :property, name: "attrVersionConfiguration", is_optional: false },
    :attr_version_configuration_data_color_palette => { kind: :property, name: "attrVersionConfigurationDataColorPalette", is_optional: false },
    :attr_version_configuration_sheet => { kind: :property, name: "attrVersionConfigurationSheet", is_optional: false },
    :attr_version_configuration_typography => { kind: :property, name: "attrVersionConfigurationTypography", is_optional: false },
    :attr_version_configuration_ui_color_palette => { kind: :property, name: "attrVersionConfigurationUiColorPalette", is_optional: false },
    :attr_version_created_time => { kind: :property, name: "attrVersionCreatedTime", is_optional: false },
    :attr_version_description => { kind: :property, name: "attrVersionDescription", is_optional: false },
    :attr_version_errors => { kind: :property, name: "attrVersionErrors", is_optional: false },
    :attr_version_status => { kind: :property, name: "attrVersionStatus", is_optional: false },
    :attr_version_version_number => { kind: :property, name: "attrVersionVersionNumber", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :theme_ref => { kind: :property, name: "themeRef", is_optional: false },
    :aws_account_id => { kind: :property, name: "awsAccountId", is_optional: false },
    :base_theme_id => { kind: :property, name: "baseThemeId", is_optional: false },
    :configuration => { kind: :property, name: "configuration", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :theme_id => { kind: :property, name: "themeId", is_optional: false },
    :permissions => { kind: :property, name: "permissions", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :version_description => { kind: :property, name: "versionDescription", 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.



451
452
453
454
 
# File 'quick_sight/cfn_theme.rb', line 451

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:



463
464
465
466
 
# File 'quick_sight/cfn_theme.rb', line 463

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:



473
474
475
476
 
# File 'quick_sight/cfn_theme.rb', line 473

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:



484
485
486
487
488
 
# File 'quick_sight/cfn_theme.rb', line 484

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.


541
542
543
544
545
 
# File 'quick_sight/cfn_theme.rb', line 541

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.



551
552
553
554
 
# File 'quick_sight/cfn_theme.rb', line 551

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.



563
564
565
566
567
 
# File 'quick_sight/cfn_theme.rb', line 563

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:



576
577
578
579
 
# File 'quick_sight/cfn_theme.rb', line 576

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:



598
599
600
601
602
603
 
# File 'quick_sight/cfn_theme.rb', line 598

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

The Amazon Resource Name (ARN) of the theme.

Returns:

  • (String) 


211
212
213
 
# File 'quick_sight/cfn_theme.rb', line 211

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ String

The time the theme was created.

Returns:

  • (String) 


218
219
220
 
# File 'quick_sight/cfn_theme.rb', line 218

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_last_updated_time ⇒ String

The time the theme was last updated.

Returns:

  • (String) 


225
226
227
 
# File 'quick_sight/cfn_theme.rb', line 225

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_type ⇒ String

Theme type.

Returns:

  • (String) 


232
233
234
 
# File 'quick_sight/cfn_theme.rb', line 232

def attr_type()
  jsii_get_property("attrType")
end

#attr_version ⇒ AWSCDK::IResolvable

A version of a theme.

.

Returns:



239
240
241
 
# File 'quick_sight/cfn_theme.rb', line 239

def attr_version()
  jsii_get_property("attrVersion")
end

#attr_version_arn ⇒ String

Returns:

  • (String) 


244
245
246
 
# File 'quick_sight/cfn_theme.rb', line 244

def attr_version_arn()
  jsii_get_property("attrVersionArn")
end

#attr_version_base_theme_id ⇒ String

Returns:

  • (String) 


249
250
251
 
# File 'quick_sight/cfn_theme.rb', line 249

def attr_version_base_theme_id()
  jsii_get_property("attrVersionBaseThemeId")
end

#attr_version_configuration ⇒ AWSCDK::IResolvable

Returns:



254
255
256
 
# File 'quick_sight/cfn_theme.rb', line 254

def attr_version_configuration()
  jsii_get_property("attrVersionConfiguration")
end

#attr_version_configuration_data_color_palette ⇒ AWSCDK::IResolvable

Returns:



259
260
261
 
# File 'quick_sight/cfn_theme.rb', line 259

def attr_version_configuration_data_color_palette()
  jsii_get_property("attrVersionConfigurationDataColorPalette")
end

#attr_version_configuration_sheet ⇒ AWSCDK::IResolvable

Returns:



264
265
266
 
# File 'quick_sight/cfn_theme.rb', line 264

def attr_version_configuration_sheet()
  jsii_get_property("attrVersionConfigurationSheet")
end

#attr_version_configuration_typography ⇒ AWSCDK::IResolvable

Returns:



269
270
271
 
# File 'quick_sight/cfn_theme.rb', line 269

def attr_version_configuration_typography()
  jsii_get_property("attrVersionConfigurationTypography")
end

#attr_version_configuration_ui_color_palette ⇒ AWSCDK::IResolvable

Returns:



274
275
276
 
# File 'quick_sight/cfn_theme.rb', line 274

def attr_version_configuration_ui_color_palette()
  jsii_get_property("attrVersionConfigurationUiColorPalette")
end

#attr_version_created_time ⇒ String

Returns:

  • (String) 


279
280
281
 
# File 'quick_sight/cfn_theme.rb', line 279

def attr_version_created_time()
  jsii_get_property("attrVersionCreatedTime")
end

#attr_version_description ⇒ String

Returns:

  • (String) 


284
285
286
 
# File 'quick_sight/cfn_theme.rb', line 284

def attr_version_description()
  jsii_get_property("attrVersionDescription")
end

#attr_version_errors ⇒ AWSCDK::IResolvable

Returns:



289
290
291
 
# File 'quick_sight/cfn_theme.rb', line 289

def attr_version_errors()
  jsii_get_property("attrVersionErrors")
end

#attr_version_status ⇒ String

Returns:

  • (String) 


294
295
296
 
# File 'quick_sight/cfn_theme.rb', line 294

def attr_version_status()
  jsii_get_property("attrVersionStatus")
end

#attr_version_version_number ⇒ AWSCDK::IResolvable

Returns:



299
300
301
 
# File 'quick_sight/cfn_theme.rb', line 299

def attr_version_version_number()
  jsii_get_property("attrVersionVersionNumber")
end

#aws_account_id ⇒ String

The ID of the AWS account where you want to store the new theme.

Returns:

  • (String) 


320
321
322
 
# File 'quick_sight/cfn_theme.rb', line 320

def ()
  jsii_get_property("awsAccountId")
end

#aws_account_id=(value) ⇒ Object 



324
325
326
327
 
# File 'quick_sight/cfn_theme.rb', line 324

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

#base_theme_id ⇒ String

The ID of the theme that a custom theme will inherit from.

Returns:

  • (String) 


332
333
334
 
# File 'quick_sight/cfn_theme.rb', line 332

def base_theme_id()
  jsii_get_property("baseThemeId")
end

#base_theme_id=(value) ⇒ Object 



336
337
338
339
 
# File 'quick_sight/cfn_theme.rb', line 336

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



157
158
159
 
# File 'quick_sight/cfn_theme.rb', line 157

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


162
163
164
 
# File 'quick_sight/cfn_theme.rb', line 162

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


607
608
609
610
 
# File 'quick_sight/cfn_theme.rb', line 607

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


167
168
169
 
# File 'quick_sight/cfn_theme.rb', line 167

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


174
175
176
 
# File 'quick_sight/cfn_theme.rb', line 174

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTheme::ThemeConfigurationProperty

The theme configuration, which contains the theme display properties.

Returns:



344
345
346
 
# File 'quick_sight/cfn_theme.rb', line 344

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



348
349
350
351
352
 
# File 'quick_sight/cfn_theme.rb', line 348

def configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTheme::ThemeConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRoZW1lLlRoZW1lQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "configuration")
  jsii_set_property("configuration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


119
120
121
 
# File 'quick_sight/cfn_theme.rb', line 119

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



179
180
181
 
# File 'quick_sight/cfn_theme.rb', line 179

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:



620
621
622
623
624
 
# File 'quick_sight/cfn_theme.rb', line 620

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:



631
632
633
634
 
# File 'quick_sight/cfn_theme.rb', line 631

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:



701
702
703
704
 
# File 'quick_sight/cfn_theme.rb', line 701

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) 


131
132
133
 
# File 'quick_sight/cfn_theme.rb', line 131

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A display name for the theme.

Returns:

  • (String) 


357
358
359
 
# File 'quick_sight/cfn_theme.rb', line 357

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



361
362
363
364
 
# File 'quick_sight/cfn_theme.rb', line 361

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


114
115
116
 
# File 'quick_sight/cfn_theme.rb', line 114

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:



642
643
644
 
# File 'quick_sight/cfn_theme.rb', line 642

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:



649
650
651
 
# File 'quick_sight/cfn_theme.rb', line 649

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.



442
443
444
445
 
# File 'quick_sight/cfn_theme.rb', line 442

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

#permissions ⇒ AWSCDK::IResolvable, ...

A valid grouping of resource permissions to apply to the new theme.

Returns:



381
382
383
 
# File 'quick_sight/cfn_theme.rb', line 381

def permissions()
  jsii_get_property("permissions")
end

#permissions=(value) ⇒ Object 



385
386
387
388
 
# File 'quick_sight/cfn_theme.rb', line 385

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


150
151
152
 
# File 'quick_sight/cfn_theme.rb', line 150

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:



660
661
662
663
 
# File 'quick_sight/cfn_theme.rb', line 660

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


667
668
669
670
 
# File 'quick_sight/cfn_theme.rb', line 667

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:



677
678
679
680
681
 
# File 'quick_sight/cfn_theme.rb', line 677

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.



686
687
688
 
# File 'quick_sight/cfn_theme.rb', line 686

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:



140
141
142
 
# File 'quick_sight/cfn_theme.rb', line 140

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



306
307
308
 
# File 'quick_sight/cfn_theme.rb', line 306

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

Returns:



393
394
395
 
# File 'quick_sight/cfn_theme.rb', line 393

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



397
398
399
400
401
 
# File 'quick_sight/cfn_theme.rb', line 397

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

#theme_id ⇒ String

An ID for the theme that you want to create.

Returns:

  • (String) 


369
370
371
 
# File 'quick_sight/cfn_theme.rb', line 369

def theme_id()
  jsii_get_property("themeId")
end

#theme_id=(value) ⇒ Object 



373
374
375
376
 
# File 'quick_sight/cfn_theme.rb', line 373

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

#theme_ref ⇒ AWSCDK::Interfaces::AWSQuicksight::ThemeReference

A reference to a Theme resource.

Returns:



313
314
315
 
# File 'quick_sight/cfn_theme.rb', line 313

def theme_ref()
  jsii_get_property("themeRef")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



418
419
420
 
# File 'quick_sight/cfn_theme.rb', line 418

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


187
188
189
 
# File 'quick_sight/cfn_theme.rb', line 187

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


197
198
199
 
# File 'quick_sight/cfn_theme.rb', line 197

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


692
693
694
695
 
# File 'quick_sight/cfn_theme.rb', line 692

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#version_description ⇒ String?

A description of the first version of the theme that you're creating.

Returns:

  • (String, nil) 


406
407
408
 
# File 'quick_sight/cfn_theme.rb', line 406

def version_description()
  jsii_get_property("versionDescription")
end

#version_description=(value) ⇒ Object 



410
411
412
413
 
# File 'quick_sight/cfn_theme.rb', line 410

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


431
432
433
434
435
436
 
# File 'quick_sight/cfn_theme.rb', line 431

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