Class: AWSCDK::QuickSight::CfnDashboard

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

Overview

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Quick that identifies Quick reports, created from analyses. You can share Quick dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDashboard

Create a new AWS::QuickSight::Dashboard.

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

    Resource properties.



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

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

Class Method Details

.arn_for_dashboard(resource) ⇒ String

Parameters:

Returns:

  • (String) 


102
103
104
105
 
# File 'quick_sight/cfn_dashboard.rb', line 102

def self.arn_for_dashboard(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xdWlja3NpZ2h0LklEYXNoYm9hcmRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnDashboard", "arnForDashboard", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


209
210
211
 
# File 'quick_sight/cfn_dashboard.rb', line 209

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

.is_cfn_dashboard(x) ⇒ Boolean

Checks whether the given object is a CfnDashboard.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_dashboard(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_quicksight.CfnDashboard", "isCfnDashboard", [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
94
95
96
97
98
 
# File 'quick_sight/cfn_dashboard.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_published_time => { kind: :property, name: "attrLastPublishedTime", 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_arn => { kind: :property, name: "attrVersionArn", is_optional: false },
    :attr_version_created_time => { kind: :property, name: "attrVersionCreatedTime", is_optional: false },
    :attr_version_data_set_arns => { kind: :property, name: "attrVersionDataSetArns", 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 },
    :dashboard_ref => { kind: :property, name: "dashboardRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :aws_account_id => { kind: :property, name: "awsAccountId", is_optional: false },
    :dashboard_id => { kind: :property, name: "dashboardId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :dashboard_publish_options => { kind: :property, name: "dashboardPublishOptions", is_optional: true },
    :definition => { kind: :property, name: "definition", is_optional: true },
    :folder_arns => { kind: :property, name: "folderArns", is_optional: true },
    :link_entities => { kind: :property, name: "linkEntities", is_optional: true },
    :link_sharing_configuration => { kind: :property, name: "linkSharingConfiguration", is_optional: true },
    :parameters => { kind: :property, name: "parameters", 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 },
    :theme_arn => { kind: :property, name: "themeArn", 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.



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

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:



543
544
545
546
 
# File 'quick_sight/cfn_dashboard.rb', line 543

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:



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

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:



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

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.


621
622
623
624
625
 
# File 'quick_sight/cfn_dashboard.rb', line 621

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.



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

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.



643
644
645
646
647
 
# File 'quick_sight/cfn_dashboard.rb', line 643

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:



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

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:



678
679
680
681
682
683
 
# File 'quick_sight/cfn_dashboard.rb', line 678

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

Returns:

  • (String) 


216
217
218
 
# File 'quick_sight/cfn_dashboard.rb', line 216

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ String

The time this dashboard version was created.

Returns:

  • (String) 


223
224
225
 
# File 'quick_sight/cfn_dashboard.rb', line 223

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_last_published_time ⇒ String

The time that the dashboard was last published.

Returns:

  • (String) 


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

def attr_last_published_time()
  jsii_get_property("attrLastPublishedTime")
end

#attr_last_updated_time ⇒ String

The time that the dashboard was last updated.

Returns:

  • (String) 


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

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_version ⇒ AWSCDK::IResolvable

Dashboard version.

.

Returns:



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

def attr_version()
  jsii_get_property("attrVersion")
end

#attr_version_arn ⇒ String

Returns:

  • (String) 


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

def attr_version_arn()
  jsii_get_property("attrVersionArn")
end

#attr_version_created_time ⇒ String

Returns:

  • (String) 


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

def attr_version_created_time()
  jsii_get_property("attrVersionCreatedTime")
end

#attr_version_data_set_arns ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def attr_version_data_set_arns()
  jsii_get_property("attrVersionDataSetArns")
end

#attr_version_description ⇒ String

Returns:

  • (String) 


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

def attr_version_description()
  jsii_get_property("attrVersionDescription")
end

#attr_version_errors ⇒ AWSCDK::IResolvable

Returns:



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

def attr_version_errors()
  jsii_get_property("attrVersionErrors")
end

#attr_version_sheets ⇒ AWSCDK::IResolvable

Returns:



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

def attr_version_sheets()
  jsii_get_property("attrVersionSheets")
end

#attr_version_source_entity_arn ⇒ String

Returns:

  • (String) 


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

def attr_version_source_entity_arn()
  jsii_get_property("attrVersionSourceEntityArn")
end

#attr_version_status ⇒ String

Returns:

  • (String) 


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

def attr_version_status()
  jsii_get_property("attrVersionStatus")
end

#attr_version_theme_arn ⇒ String

Returns:

  • (String) 


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

def attr_version_theme_arn()
  jsii_get_property("attrVersionThemeArn")
end

#attr_version_version_number ⇒ AWSCDK::IResolvable

Returns:



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

def attr_version_version_number()
  jsii_get_property("attrVersionVersionNumber")
end

#aws_account_id ⇒ String

The ID of the AWS account where you want to create the dashboard.

Returns:

  • (String) 


315
316
317
 
# File 'quick_sight/cfn_dashboard.rb', line 315

def ()
  jsii_get_property("awsAccountId")
end

#aws_account_id=(value) ⇒ Object 



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

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:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


687
688
689
690
 
# File 'quick_sight/cfn_dashboard.rb', line 687

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#dashboard_id ⇒ String

The ID for the dashboard, also added to the IAM policy.

Returns:

  • (String) 


327
328
329
 
# File 'quick_sight/cfn_dashboard.rb', line 327

def dashboard_id()
  jsii_get_property("dashboardId")
end

#dashboard_id=(value) ⇒ Object 



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

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

#dashboard_publish_options ⇒ AWSCDK::IResolvable, ...

Options for publishing the dashboard when you create it:.

Returns:



351
352
353
 
# File 'quick_sight/cfn_dashboard.rb', line 351

def dashboard_publish_options()
  jsii_get_property("dashboardPublishOptions")
end

#dashboard_publish_options=(value) ⇒ Object 



355
356
357
358
359
 
# File 'quick_sight/cfn_dashboard.rb', line 355

def dashboard_publish_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DashboardPublishOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXNoYm9hcmRQdWJsaXNoT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "dashboardPublishOptions") unless value.nil?
  jsii_set_property("dashboardPublishOptions", value)
end

#dashboard_ref ⇒ AWSCDK::Interfaces::AWSQuicksight::DashboardReference

A reference to a Dashboard resource.

Returns:



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

def dashboard_ref()
  jsii_get_property("dashboardRef")
end

#definition ⇒ AWSCDK::IResolvable, ...

Returns:



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

def definition()
  jsii_get_property("definition")
end

#definition=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



184
185
186
 
# File 'quick_sight/cfn_dashboard.rb', line 184

def env()
  jsii_get_property("env")
end

#folder_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

def folder_arns()
  jsii_get_property("folderArns")
end

#folder_arns=(value) ⇒ Object 



377
378
379
380
 
# File 'quick_sight/cfn_dashboard.rb', line 377

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:



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

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:



711
712
713
714
 
# File 'quick_sight/cfn_dashboard.rb', line 711

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:



781
782
783
784
 
# File 'quick_sight/cfn_dashboard.rb', line 781

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#link_entities ⇒ Array<String>?

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

  • (Array<String>, nil) 


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

def link_entities()
  jsii_get_property("linkEntities")
end

#link_entities=(value) ⇒ Object 



389
390
391
392
 
# File 'quick_sight/cfn_dashboard.rb', line 389

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

#link_sharing_configuration ⇒ AWSCDK::IResolvable, ...

A structure that contains the link sharing configurations that you want to apply overrides to.

Returns:



397
398
399
 
# File 'quick_sight/cfn_dashboard.rb', line 397

def link_sharing_configuration()
  jsii_get_property("linkSharingConfiguration")
end

#link_sharing_configuration=(value) ⇒ Object 



401
402
403
404
405
 
# File 'quick_sight/cfn_dashboard.rb', line 401

def link_sharing_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::LinkSharingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5MaW5rU2hhcmluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "linkSharingConfiguration") unless value.nil?
  jsii_set_property("linkSharingConfiguration", value)
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) 


136
137
138
 
# File 'quick_sight/cfn_dashboard.rb', line 136

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The display name of the dashboard.

Returns:

  • (String) 


339
340
341
 
# File 'quick_sight/cfn_dashboard.rb', line 339

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


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

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:



722
723
724
 
# File 'quick_sight/cfn_dashboard.rb', line 722

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:



729
730
731
 
# File 'quick_sight/cfn_dashboard.rb', line 729

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.



522
523
524
525
 
# File 'quick_sight/cfn_dashboard.rb', line 522

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 parameters for the creation of the dashboard, which you want to use to override the default settings.

Returns:



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

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



414
415
416
417
418
 
# File 'quick_sight/cfn_dashboard.rb', line 414

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

#permissions ⇒ AWSCDK::IResolvable, ...

A structure that contains the permissions of the dashboard.

Returns:



423
424
425
 
# File 'quick_sight/cfn_dashboard.rb', line 423

def permissions()
  jsii_get_property("permissions")
end

#permissions=(value) ⇒ Object 



427
428
429
430
 
# File 'quick_sight/cfn_dashboard.rb', line 427

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


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

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:



740
741
742
743
 
# File 'quick_sight/cfn_dashboard.rb', line 740

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


747
748
749
750
 
# File 'quick_sight/cfn_dashboard.rb', line 747

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:



757
758
759
760
761
 
# File 'quick_sight/cfn_dashboard.rb', line 757

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.



766
767
768
 
# File 'quick_sight/cfn_dashboard.rb', line 766

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

Returns:



435
436
437
 
# File 'quick_sight/cfn_dashboard.rb', line 435

def source_entity()
  jsii_get_property("sourceEntity")
end

#source_entity=(value) ⇒ Object 



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

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



145
146
147
 
# File 'quick_sight/cfn_dashboard.rb', line 145

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

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

Returns:



448
449
450
 
# File 'quick_sight/cfn_dashboard.rb', line 448

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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 Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

Returns:

  • (String, nil) 


461
462
463
 
# File 'quick_sight/cfn_dashboard.rb', line 461

def theme_arn()
  jsii_get_property("themeArn")
end

#theme_arn=(value) ⇒ Object 



465
466
467
468
 
# File 'quick_sight/cfn_dashboard.rb', line 465

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



498
499
500
 
# File 'quick_sight/cfn_dashboard.rb', line 498

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


192
193
194
 
# File 'quick_sight/cfn_dashboard.rb', line 192

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


202
203
204
 
# File 'quick_sight/cfn_dashboard.rb', line 202

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


772
773
774
775
 
# File 'quick_sight/cfn_dashboard.rb', line 772

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:



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

def validation_strategy()
  jsii_get_property("validationStrategy")
end

#validation_strategy=(value) ⇒ Object 



477
478
479
480
481
 
# File 'quick_sight/cfn_dashboard.rb', line 477

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

#version_description ⇒ String?

A description for the first version of the dashboard being created.

Returns:

  • (String, nil) 


486
487
488
 
# File 'quick_sight/cfn_dashboard.rb', line 486

def version_description()
  jsii_get_property("versionDescription")
end

#version_description=(value) ⇒ Object 



490
491
492
493
 
# File 'quick_sight/cfn_dashboard.rb', line 490

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) 


511
512
513
514
515
516
 
# File 'quick_sight/cfn_dashboard.rb', line 511

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