Class: AWSCDK::QuickSight::CfnDashboardProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard_props.rb

Overview

Properties for defining a CfnDashboard.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aws_account_id:, dashboard_id:, name:, dashboard_publish_options: nil, definition: nil, folder_arns: nil, link_entities: nil, link_sharing_configuration: nil, parameters: nil, permissions: nil, source_entity: nil, tags: nil, theme_arn: nil, validation_strategy: nil, version_description: nil) ⇒ CfnDashboardProps

Returns a new instance of CfnDashboardProps.

Parameters:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'quick_sight/cfn_dashboard_props.rb', line 24

def initialize(aws_account_id:, dashboard_id:, name:, dashboard_publish_options: nil, definition: nil, folder_arns: nil, link_entities: nil, link_sharing_configuration: nil, parameters: nil, permissions: nil, source_entity: nil, tags: nil, theme_arn: nil, validation_strategy: nil, version_description: nil)
  @aws_account_id = 
  Jsii::Type.check_type(@aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsAccountId")
  @dashboard_id = dashboard_id
  Jsii::Type.check_type(@dashboard_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dashboardId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @dashboard_publish_options = dashboard_publish_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DashboardPublishOptionsProperty.new(**dashboard_publish_options.transform_keys(&:to_sym)) : dashboard_publish_options
  Jsii::Type.check_type(@dashboard_publish_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXNoYm9hcmRQdWJsaXNoT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "dashboardPublishOptions") unless @dashboard_publish_options.nil?
  @definition = definition.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DashboardVersionDefinitionProperty.new(**definition.transform_keys(&:to_sym)) : definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXNoYm9hcmRWZXJzaW9uRGVmaW5pdGlvblByb3BlcnR5In1dfX0=")), "definition") unless @definition.nil?
  @folder_arns = folder_arns
  Jsii::Type.check_type(@folder_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "folderArns") unless @folder_arns.nil?
  @link_entities = link_entities
  Jsii::Type.check_type(@link_entities, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "linkEntities") unless @link_entities.nil?
  @link_sharing_configuration = link_sharing_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::LinkSharingConfigurationProperty.new(**link_sharing_configuration.transform_keys(&:to_sym)) : link_sharing_configuration
  Jsii::Type.check_type(@link_sharing_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5MaW5rU2hhcmluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "linkSharingConfiguration") unless @link_sharing_configuration.nil?
  @parameters = parameters.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParametersProperty.new(**parameters.transform_keys(&:to_sym)) : parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "parameters") unless @parameters.nil?
  @permissions = permissions
  Jsii::Type.check_type(@permissions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuUmVzb3VyY2VQZXJtaXNzaW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "permissions") unless @permissions.nil?
  @source_entity = source_entity.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DashboardSourceEntityProperty.new(**source_entity.transform_keys(&:to_sym)) : source_entity
  Jsii::Type.check_type(@source_entity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXNoYm9hcmRTb3VyY2VFbnRpdHlQcm9wZXJ0eSJ9XX19")), "sourceEntity") unless @source_entity.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @theme_arn = theme_arn
  Jsii::Type.check_type(@theme_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19xdWlja3NpZ2h0LklUaGVtZVJlZiJ9XX19")), "themeArn") unless @theme_arn.nil?
  @validation_strategy = validation_strategy.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ValidationStrategyProperty.new(**validation_strategy.transform_keys(&:to_sym)) : validation_strategy
  Jsii::Type.check_type(@validation_strategy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WYWxpZGF0aW9uU3RyYXRlZ3lQcm9wZXJ0eSJ9XX19")), "validationStrategy") unless @validation_strategy.nil?
  @version_description = version_description
  Jsii::Type.check_type(@version_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionDescription") unless @version_description.nil?
end

Instance Attribute Details

#aws_account_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



61
62
63
 
# File 'quick_sight/cfn_dashboard_props.rb', line 61

def 
  @aws_account_id
end

#dashboard_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



66
67
68
 
# File 'quick_sight/cfn_dashboard_props.rb', line 66

def dashboard_id
  @dashboard_id
end

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

Options for publishing the dashboard when you create it:.

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
  • AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED . This option is DISABLED by default.
  • AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED . The option to build an executive summary is disabled when this is set to DISABLED . This option is ENABLED by default.
  • AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED . The option to share a data story is disabled when this is set to DISABLED . This option is ENABLED by default.

Returns:

See Also:



83
84
85
 
# File 'quick_sight/cfn_dashboard_props.rb', line 83

def dashboard_publish_options
  @dashboard_publish_options
end

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

Returns:

See Also:



86
87
88
 
# File 'quick_sight/cfn_dashboard_props.rb', line 86

def definition
  @definition
end

#folder_arns ⇒ Array<String>? (readonly)

Returns:

  • (Array<String>, nil)

See Also:



89
90
91
 
# File 'quick_sight/cfn_dashboard_props.rb', line 89

def folder_arns
  @folder_arns
end

#link_entities ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



94
95
96
 
# File 'quick_sight/cfn_dashboard_props.rb', line 94

def link_entities
  @link_entities
end

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

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

Returns:

See Also:



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

def link_sharing_configuration
  @link_sharing_configuration
end

#name ⇒ String (readonly)

The display name of the dashboard.

Returns:

  • (String)

See Also:



71
72
73
 
# File 'quick_sight/cfn_dashboard_props.rb', line 71

def name
  @name
end

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

The parameters for the creation of the dashboard, which you want to use to override the default settings.

A dashboard can have any type of parameters, and some parameters might accept multiple values.

Returns:

See Also:



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

def parameters
  @parameters
end

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

A structure that contains the permissions of the dashboard.

You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Returns:

See Also:



115
116
117
 
# File 'quick_sight/cfn_dashboard_props.rb', line 115

def permissions
  @permissions
end

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

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

In SourceEntity , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS account; and any QuickSight-supported AWS Region .

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Returns:

See Also:



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

def source_entity
  @source_entity
end

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

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

Returns:

See Also:



129
130
131
 
# File 'quick_sight/cfn_dashboard_props.rb', line 129

def tags
  @tags
end

#theme_arn ⇒ String, ... (readonly)

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Returns:

See Also:



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

def theme_arn
  @theme_arn
end

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

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

When you set this value to LENIENT , validation is skipped for specific errors.

Returns:

See Also:



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

def validation_strategy
  @validation_strategy
end

#version_description ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



148
149
150
 
# File 'quick_sight/cfn_dashboard_props.rb', line 148

def version_description
  @version_description
end

Class Method Details

.jsii_properties ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'quick_sight/cfn_dashboard_props.rb', line 150

def self.jsii_properties
  {
    :aws_account_id => "awsAccountId",
    :dashboard_id => "dashboardId",
    :name => "name",
    :dashboard_publish_options => "dashboardPublishOptions",
    :definition => "definition",
    :folder_arns => "folderArns",
    :link_entities => "linkEntities",
    :link_sharing_configuration => "linkSharingConfiguration",
    :parameters => "parameters",
    :permissions => "permissions",
    :source_entity => "sourceEntity",
    :tags => "tags",
    :theme_arn => "themeArn",
    :validation_strategy => "validationStrategy",
    :version_description => "versionDescription",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'quick_sight/cfn_dashboard_props.rb', line 170

def to_jsii
  result = {}
  result.merge!({
    "awsAccountId" => @aws_account_id,
    "dashboardId" => @dashboard_id,
    "name" => @name,
    "dashboardPublishOptions" => @dashboard_publish_options,
    "definition" => @definition,
    "folderArns" => @folder_arns,
    "linkEntities" => @link_entities,
    "linkSharingConfiguration" => @link_sharing_configuration,
    "parameters" => @parameters,
    "permissions" => @permissions,
    "sourceEntity" => @source_entity,
    "tags" => @tags,
    "themeArn" => @theme_arn,
    "validationStrategy" => @validation_strategy,
    "versionDescription" => @version_description,
  })
  result.compact
end