Class: AWSCDK::QuickSight::CfnTemplate

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

Overview

Creates a template from an existing Quick analysis or template.

You can use the resulting template to create a dashboard.

A template is an entity in Quick that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTemplate

Create a new AWS::QuickSight::Template.

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::CfnTemplateProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'quick_sight/cfn_template.rb', line 22

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

Class Method Details

.arn_for_template(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'quick_sight/cfn_template.rb', line 96

def self.arn_for_template(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xdWlja3NpZ2h0LklUZW1wbGF0ZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnTemplate", "arnForTemplate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


203
204
205
 
# File 'quick_sight/cfn_template.rb', line 203

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

.is_cfn_template(x) ⇒ Boolean

Checks whether the given object is a CfnTemplate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'quick_sight/cfn_template.rb', line 105

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'quick_sight/cfn_template.rb', line 30

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_version => { kind: :property, name: "attrVersion", is_optional: false },
    :attr_version_created_time => { kind: :property, name: "attrVersionCreatedTime", is_optional: false },
    :attr_version_data_set_configurations => { kind: :property, name: "attrVersionDataSetConfigurations", 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_sheets => { kind: :property, name: "attrVersionSheets", is_optional: false },
    :attr_version_source_entity_arn => { kind: :property, name: "attrVersionSourceEntityArn", is_optional: false },
    :attr_version_status => { kind: :property, name: "attrVersionStatus", is_optional: false },
    :attr_version_theme_arn => { kind: :property, name: "attrVersionThemeArn", is_optional: false },
    :attr_version_version_number => { kind: :property, name: "attrVersionVersionNumber", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :template_ref => { kind: :property, name: "templateRef", is_optional: false },
    :aws_account_id => { kind: :property, name: "awsAccountId", is_optional: false },
    :template_id => { kind: :property, name: "templateId", is_optional: false },
    :definition => { kind: :property, name: "definition", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :permissions => { kind: :property, name: "permissions", is_optional: true },
    :source_entity => { kind: :property, name: "sourceEntity", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :validation_strategy => { kind: :property, name: "validationStrategy", 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.



440
441
442
443
 
# File 'quick_sight/cfn_template.rb', line 440

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:



452
453
454
455
 
# File 'quick_sight/cfn_template.rb', line 452

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:



462
463
464
465
 
# File 'quick_sight/cfn_template.rb', line 462

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:



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

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.


530
531
532
533
534
 
# File 'quick_sight/cfn_template.rb', line 530

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.



540
541
542
543
 
# File 'quick_sight/cfn_template.rb', line 540

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.



552
553
554
555
556
 
# File 'quick_sight/cfn_template.rb', line 552

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:



565
566
567
568
 
# File 'quick_sight/cfn_template.rb', line 565

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:



587
588
589
590
591
592
 
# File 'quick_sight/cfn_template.rb', line 587

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

Returns:

  • (String) 


210
211
212
 
# File 'quick_sight/cfn_template.rb', line 210

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ String

The time this template was created.

Returns:

  • (String) 


217
218
219
 
# File 'quick_sight/cfn_template.rb', line 217

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_last_updated_time ⇒ String

The time this template was last updated.

Returns:

  • (String) 


224
225
226
 
# File 'quick_sight/cfn_template.rb', line 224

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_version ⇒ AWSCDK::IResolvable

A version of a template.

.

Returns:



231
232
233
 
# File 'quick_sight/cfn_template.rb', line 231

def attr_version()
  jsii_get_property("attrVersion")
end

#attr_version_created_time ⇒ String

Returns:

  • (String) 


236
237
238
 
# File 'quick_sight/cfn_template.rb', line 236

def attr_version_created_time()
  jsii_get_property("attrVersionCreatedTime")
end

#attr_version_data_set_configurations ⇒ AWSCDK::IResolvable

Returns:



241
242
243
 
# File 'quick_sight/cfn_template.rb', line 241

def attr_version_data_set_configurations()
  jsii_get_property("attrVersionDataSetConfigurations")
end

#attr_version_description ⇒ String

Returns:

  • (String) 


246
247
248
 
# File 'quick_sight/cfn_template.rb', line 246

def attr_version_description()
  jsii_get_property("attrVersionDescription")
end

#attr_version_errors ⇒ AWSCDK::IResolvable

Returns:



251
252
253
 
# File 'quick_sight/cfn_template.rb', line 251

def attr_version_errors()
  jsii_get_property("attrVersionErrors")
end

#attr_version_sheets ⇒ AWSCDK::IResolvable

Returns:



256
257
258
 
# File 'quick_sight/cfn_template.rb', line 256

def attr_version_sheets()
  jsii_get_property("attrVersionSheets")
end

#attr_version_source_entity_arn ⇒ String

Returns:

  • (String) 


261
262
263
 
# File 'quick_sight/cfn_template.rb', line 261

def attr_version_source_entity_arn()
  jsii_get_property("attrVersionSourceEntityArn")
end

#attr_version_status ⇒ String

Returns:

  • (String) 


266
267
268
 
# File 'quick_sight/cfn_template.rb', line 266

def attr_version_status()
  jsii_get_property("attrVersionStatus")
end

#attr_version_theme_arn ⇒ String

Returns:

  • (String) 


271
272
273
 
# File 'quick_sight/cfn_template.rb', line 271

def attr_version_theme_arn()
  jsii_get_property("attrVersionThemeArn")
end

#attr_version_version_number ⇒ AWSCDK::IResolvable

Returns:



276
277
278
 
# File 'quick_sight/cfn_template.rb', line 276

def attr_version_version_number()
  jsii_get_property("attrVersionVersionNumber")
end

#aws_account_id ⇒ String

The ID for the AWS account that the group is in.

Returns:

  • (String) 


297
298
299
 
# File 'quick_sight/cfn_template.rb', line 297

def ()
  jsii_get_property("awsAccountId")
end

#aws_account_id=(value) ⇒ Object 



301
302
303
304
 
# File 'quick_sight/cfn_template.rb', line 301

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



156
157
158
 
# File 'quick_sight/cfn_template.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'quick_sight/cfn_template.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


596
597
598
599
 
# File 'quick_sight/cfn_template.rb', line 596

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


166
167
168
 
# File 'quick_sight/cfn_template.rb', line 166

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'quick_sight/cfn_template.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'quick_sight/cfn_template.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#definition ⇒ AWSCDK::IResolvable, ...

Returns:



319
320
321
 
# File 'quick_sight/cfn_template.rb', line 319

def definition()
  jsii_get_property("definition")
end

#definition=(value) ⇒ Object 



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

def definition=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TemplateVersionDefinitionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRlbXBsYXRlVmVyc2lvbkRlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "definition") unless value.nil?
  jsii_set_property("definition", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'quick_sight/cfn_template.rb', line 178

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:



609
610
611
612
613
 
# File 'quick_sight/cfn_template.rb', line 609

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:



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

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:



690
691
692
693
 
# File 'quick_sight/cfn_template.rb', line 690

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) 


130
131
132
 
# File 'quick_sight/cfn_template.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

A display name for the template.

Returns:

  • (String, nil) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


113
114
115
 
# File 'quick_sight/cfn_template.rb', line 113

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:



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

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:



638
639
640
 
# File 'quick_sight/cfn_template.rb', line 638

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.



431
432
433
434
 
# File 'quick_sight/cfn_template.rb', line 431

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 list of resource permissions to be set on the template.

Returns:



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

def permissions()
  jsii_get_property("permissions")
end

#permissions=(value) ⇒ Object 



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

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


149
150
151
 
# File 'quick_sight/cfn_template.rb', line 149

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:



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

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


656
657
658
659
 
# File 'quick_sight/cfn_template.rb', line 656

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:



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

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.



675
676
677
 
# File 'quick_sight/cfn_template.rb', line 675

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

#source_entity ⇒ AWSCDK::IResolvable, ...

The entity that you are using as a source when you create the template.

Returns:



356
357
358
 
# File 'quick_sight/cfn_template.rb', line 356

def source_entity()
  jsii_get_property("sourceEntity")
end

#source_entity=(value) ⇒ Object 



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

def source_entity=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TemplateSourceEntityProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRlbXBsYXRlU291cmNlRW50aXR5UHJvcGVydHkifV19fQ==")), "sourceEntity") unless value.nil?
  jsii_set_property("sourceEntity", 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:



139
140
141
 
# File 'quick_sight/cfn_template.rb', line 139

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



283
284
285
 
# File 'quick_sight/cfn_template.rb', line 283

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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

#template_id ⇒ String

An ID for the template that you want to create.

Returns:

  • (String) 


309
310
311
 
# File 'quick_sight/cfn_template.rb', line 309

def template_id()
  jsii_get_property("templateId")
end

#template_id=(value) ⇒ Object 



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

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

#template_ref ⇒ AWSCDK::Interfaces::AWSQuicksight::TemplateReference

A reference to a Template resource.

Returns:



290
291
292
 
# File 'quick_sight/cfn_template.rb', line 290

def template_ref()
  jsii_get_property("templateRef")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



407
408
409
 
# File 'quick_sight/cfn_template.rb', line 407

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


186
187
188
 
# File 'quick_sight/cfn_template.rb', line 186

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


196
197
198
 
# File 'quick_sight/cfn_template.rb', line 196

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


681
682
683
684
 
# File 'quick_sight/cfn_template.rb', line 681

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

#validation_strategy ⇒ AWSCDK::IResolvable, ...

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

Returns:



382
383
384
 
# File 'quick_sight/cfn_template.rb', line 382

def validation_strategy()
  jsii_get_property("validationStrategy")
end

#validation_strategy=(value) ⇒ Object 



386
387
388
389
390
 
# File 'quick_sight/cfn_template.rb', line 386

def validation_strategy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ValidationStrategyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZhbGlkYXRpb25TdHJhdGVneVByb3BlcnR5In1dfX0=")), "validationStrategy") unless value.nil?
  jsii_set_property("validationStrategy", value)
end

#version_description ⇒ String?

A description of the current template version being created.

Returns:

  • (String, nil) 


395
396
397
 
# File 'quick_sight/cfn_template.rb', line 395

def version_description()
  jsii_get_property("versionDescription")
end

#version_description=(value) ⇒ Object 



399
400
401
402
 
# File 'quick_sight/cfn_template.rb', line 399

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) 


420
421
422
423
424
425
 
# File 'quick_sight/cfn_template.rb', line 420

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