Class: AWSCDK::QuickSight::CfnAnalysis

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

Overview

Creates an analysis in Amazon QuickSight.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAnalysis

Create a new AWS::QuickSight::Analysis.

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

    Resource properties.



18
19
20
21
22
23
24
 
# File 'quick_sight/cfn_analysis.rb', line 18

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

Class Method Details

.arn_for_analysis(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'quick_sight/cfn_analysis.rb', line 90

def self.arn_for_analysis(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xdWlja3NpZ2h0LklBbmFseXNpc1JlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnAnalysis", "arnForAnalysis", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_analysis(x) ⇒ Boolean

Checks whether the given object is a CfnAnalysis.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'quick_sight/cfn_analysis.rb', line 99

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

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'quick_sight/cfn_analysis.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 },
    :analysis_ref => { kind: :property, name: "analysisRef", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_time => { kind: :property, name: "attrCreatedTime", is_optional: false },
    :attr_data_set_arns => { kind: :property, name: "attrDataSetArns", is_optional: false },
    :attr_errors => { kind: :property, name: "attrErrors", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_sheets => { kind: :property, name: "attrSheets", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :analysis_id => { kind: :property, name: "analysisId", is_optional: false },
    :aws_account_id => { kind: :property, name: "awsAccountId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :definition => { kind: :property, name: "definition", is_optional: true },
    :errors => { kind: :property, name: "errors", is_optional: true },
    :folder_arns => { kind: :property, name: "folderArns", is_optional: true },
    :parameters => { kind: :property, name: "parameters", is_optional: true },
    :permissions => { kind: :property, name: "permissions", is_optional: true },
    :sheets => { kind: :property, name: "sheets", is_optional: true },
    :source_entity => { kind: :property, name: "sourceEntity", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :theme_arn => { kind: :property, name: "themeArn", is_optional: true },
    :validation_strategy => { kind: :property, name: "validationStrategy", 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.



458
459
460
461
 
# File 'quick_sight/cfn_analysis.rb', line 458

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:



470
471
472
473
 
# File 'quick_sight/cfn_analysis.rb', line 470

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:



480
481
482
483
 
# File 'quick_sight/cfn_analysis.rb', line 480

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:



491
492
493
494
495
 
# File 'quick_sight/cfn_analysis.rb', line 491

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.


548
549
550
551
552
 
# File 'quick_sight/cfn_analysis.rb', line 548

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.



558
559
560
561
 
# File 'quick_sight/cfn_analysis.rb', line 558

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.



570
571
572
573
574
 
# File 'quick_sight/cfn_analysis.rb', line 570

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

#analysis_id ⇒ String

The ID for the analysis that you're creating.

Returns:

  • (String) 


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

def analysis_id()
  jsii_get_property("analysisId")
end

#analysis_id=(value) ⇒ Object 



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

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

#analysis_ref ⇒ AWSCDK::Interfaces::AWSQuicksight::AnalysisReference

A reference to a Analysis resource.

Returns:



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

def analysis_ref()
  jsii_get_property("analysisRef")
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:



583
584
585
586
 
# File 'quick_sight/cfn_analysis.rb', line 583

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:



605
606
607
608
609
610
 
# File 'quick_sight/cfn_analysis.rb', line 605

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

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ String

The time that the analysis was created.

Returns:

  • (String) 


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

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_data_set_arns ⇒ Array<String>

The ARNs of the datasets of the analysis.

Returns:

  • (Array<String>) 


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

def attr_data_set_arns()
  jsii_get_property("attrDataSetArns")
end

#attr_errors ⇒ AWSCDK::IResolvable

Returns:



230
231
232
 
# File 'quick_sight/cfn_analysis.rb', line 230

def attr_errors()
  jsii_get_property("attrErrors")
end

#attr_last_updated_time ⇒ String

The time that the analysis was last updated.

Returns:

  • (String) 


237
238
239
 
# File 'quick_sight/cfn_analysis.rb', line 237

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_sheets ⇒ AWSCDK::IResolvable

Returns:



242
243
244
 
# File 'quick_sight/cfn_analysis.rb', line 242

def attr_sheets()
  jsii_get_property("attrSheets")
end

#aws_account_id ⇒ String

The ID of the AWS account where you are creating an analysis.

Returns:

  • (String) 


268
269
270
 
# File 'quick_sight/cfn_analysis.rb', line 268

def ()
  jsii_get_property("awsAccountId")
end

#aws_account_id=(value) ⇒ Object 



272
273
274
275
 
# File 'quick_sight/cfn_analysis.rb', line 272

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:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'quick_sight/cfn_analysis.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


614
615
616
617
 
# File 'quick_sight/cfn_analysis.rb', line 614

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


160
161
162
 
# File 'quick_sight/cfn_analysis.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'quick_sight/cfn_analysis.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#definition ⇒ AWSCDK::IResolvable, ...

Returns:



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

def definition()
  jsii_get_property("definition")
end

#definition=(value) ⇒ Object 



294
295
296
297
298
 
# File 'quick_sight/cfn_analysis.rb', line 294

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



172
173
174
 
# File 'quick_sight/cfn_analysis.rb', line 172

def env()
  jsii_get_property("env")
end

#errors ⇒ AWSCDK::IResolvable, ...

Errors associated with the analysis.

Returns:



303
304
305
 
# File 'quick_sight/cfn_analysis.rb', line 303

def errors()
  jsii_get_property("errors")
end

#errors=(value) ⇒ Object 



307
308
309
310
 
# File 'quick_sight/cfn_analysis.rb', line 307

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

#folder_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

def folder_arns()
  jsii_get_property("folderArns")
end

#folder_arns=(value) ⇒ Object 



317
318
319
320
 
# File 'quick_sight/cfn_analysis.rb', line 317

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



627
628
629
630
631
 
# File 'quick_sight/cfn_analysis.rb', line 627

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:



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

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:



708
709
710
711
 
# File 'quick_sight/cfn_analysis.rb', line 708

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) 


124
125
126
 
# File 'quick_sight/cfn_analysis.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A descriptive name for the analysis that you're creating.

Returns:

  • (String) 


280
281
282
 
# File 'quick_sight/cfn_analysis.rb', line 280

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


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

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:



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

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:



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

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.



449
450
451
452
 
# File 'quick_sight/cfn_analysis.rb', line 449

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

#parameters ⇒ AWSCDK::IResolvable, ...

The parameter names and override values that you want to use.

Returns:



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

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



329
330
331
332
333
 
# File 'quick_sight/cfn_analysis.rb', line 329

def parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "parameters") unless value.nil?
  jsii_set_property("parameters", value)
end

#permissions ⇒ AWSCDK::IResolvable, ...

A structure that describes the principals and the resource-level permissions on an analysis.

Returns:



338
339
340
 
# File 'quick_sight/cfn_analysis.rb', line 338

def permissions()
  jsii_get_property("permissions")
end

#permissions=(value) ⇒ Object 



342
343
344
345
 
# File 'quick_sight/cfn_analysis.rb', line 342

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


143
144
145
 
# File 'quick_sight/cfn_analysis.rb', line 143

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:



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

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


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

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:



684
685
686
687
688
 
# File 'quick_sight/cfn_analysis.rb', line 684

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

#sheets ⇒ AWSCDK::IResolvable, ...

A list of the associated sheets with the unique identifier and name of each sheet.

Returns:



350
351
352
 
# File 'quick_sight/cfn_analysis.rb', line 350

def sheets()
  jsii_get_property("sheets")
end

#sheets=(value) ⇒ Object 



354
355
356
357
 
# File 'quick_sight/cfn_analysis.rb', line 354

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



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

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

#source_entity ⇒ AWSCDK::IResolvable, ...

A source entity to use for the analysis that you're creating.

Returns:



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

def source_entity()
  jsii_get_property("sourceEntity")
end

#source_entity=(value) ⇒ Object 



366
367
368
369
370
 
# File 'quick_sight/cfn_analysis.rb', line 366

def source_entity=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AnalysisSourceEntityProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkFuYWx5c2lzU291cmNlRW50aXR5UHJvcGVydHkifV19fQ==")), "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:



133
134
135
 
# File 'quick_sight/cfn_analysis.rb', line 133

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

Status associated with the analysis.

Returns:

  • (String, nil) 


375
376
377
 
# File 'quick_sight/cfn_analysis.rb', line 375

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



379
380
381
382
 
# File 'quick_sight/cfn_analysis.rb', line 379

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

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

Returns:



387
388
389
 
# File 'quick_sight/cfn_analysis.rb', line 387

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



391
392
393
394
395
 
# File 'quick_sight/cfn_analysis.rb', line 391

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

The ARN for the theme to apply to the analysis that you're creating.

Returns:

  • (String, nil) 


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

def theme_arn()
  jsii_get_property("themeArn")
end

#theme_arn=(value) ⇒ Object 



404
405
406
407
 
# File 'quick_sight/cfn_analysis.rb', line 404

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



425
426
427
 
# File 'quick_sight/cfn_analysis.rb', line 425

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


180
181
182
 
# File 'quick_sight/cfn_analysis.rb', line 180

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


190
191
192
 
# File 'quick_sight/cfn_analysis.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


699
700
701
702
 
# File 'quick_sight/cfn_analysis.rb', line 699

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:



412
413
414
 
# File 'quick_sight/cfn_analysis.rb', line 412

def validation_strategy()
  jsii_get_property("validationStrategy")
end

#validation_strategy=(value) ⇒ Object 



416
417
418
419
420
 
# File 'quick_sight/cfn_analysis.rb', line 416

def validation_strategy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ValidationStrategyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZhbGlkYXRpb25TdHJhdGVneVByb3BlcnR5In1dfX0=")), "validationStrategy") unless value.nil?
  jsii_set_property("validationStrategy", 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) 


438
439
440
441
442
443
 
# File 'quick_sight/cfn_analysis.rb', line 438

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