Class: AWSCDK::QuickSight::CfnAnalysisProps

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

Overview

Properties for defining a CfnAnalysis.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(analysis_id:, aws_account_id:, name:, definition: nil, errors: nil, folder_arns: nil, parameters: nil, permissions: nil, sheets: nil, source_entity: nil, status: nil, tags: nil, theme_arn: nil, validation_strategy: nil) ⇒ CfnAnalysisProps

Returns a new instance of CfnAnalysisProps.

Parameters:



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

def initialize(analysis_id:, aws_account_id:, name:, definition: nil, errors: nil, folder_arns: nil, parameters: nil, permissions: nil, sheets: nil, source_entity: nil, status: nil, tags: nil, theme_arn: nil, validation_strategy: nil)
  @analysis_id = analysis_id
  Jsii::Type.check_type(@analysis_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "analysisId")
  @aws_account_id = 
  Jsii::Type.check_type(@aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsAccountId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @definition = definition.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AnalysisDefinitionProperty.new(**definition.transform_keys(&:to_sym)) : definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkFuYWx5c2lzRGVmaW5pdGlvblByb3BlcnR5In1dfX0=")), "definition") unless @definition.nil?
  @errors = errors
  Jsii::Type.check_type(@errors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5BbmFseXNpc0Vycm9yUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "errors") unless @errors.nil?
  @folder_arns = folder_arns
  Jsii::Type.check_type(@folder_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "folderArns") unless @folder_arns.nil?
  @parameters = parameters.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ParametersProperty.new(**parameters.transform_keys(&:to_sym)) : parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "parameters") unless @parameters.nil?
  @permissions = permissions
  Jsii::Type.check_type(@permissions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5SZXNvdXJjZVBlcm1pc3Npb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "permissions") unless @permissions.nil?
  @sheets = sheets
  Jsii::Type.check_type(@sheets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5TaGVldFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "sheets") unless @sheets.nil?
  @source_entity = source_entity.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AnalysisSourceEntityProperty.new(**source_entity.transform_keys(&:to_sym)) : source_entity
  Jsii::Type.check_type(@source_entity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkFuYWx5c2lzU291cmNlRW50aXR5UHJvcGVydHkifV19fQ==")), "sourceEntity") unless @source_entity.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.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("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "themeArn") unless @theme_arn.nil?
  @validation_strategy = validation_strategy.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ValidationStrategyProperty.new(**validation_strategy.transform_keys(&:to_sym)) : validation_strategy
  Jsii::Type.check_type(@validation_strategy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlZhbGlkYXRpb25TdHJhdGVneVByb3BlcnR5In1dfX0=")), "validationStrategy") unless @validation_strategy.nil?
end

Instance Attribute Details

#analysis_id ⇒ String (readonly)

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

Returns:

  • (String)

See Also:



60
61
62
 
# File 'quick_sight/cfn_analysis_props.rb', line 60

def analysis_id
  @analysis_id
end

#aws_account_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



65
66
67
 
# File 'quick_sight/cfn_analysis_props.rb', line 65

def 
  @aws_account_id
end

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

Returns:

See Also:



75
76
77
 
# File 'quick_sight/cfn_analysis_props.rb', line 75

def definition
  @definition
end

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

Errors associated with the analysis.

Returns:

See Also:



80
81
82
 
# File 'quick_sight/cfn_analysis_props.rb', line 80

def errors
  @errors
end

#folder_arns ⇒ Array<String>? (readonly)

Returns:

  • (Array<String>, nil)

See Also:



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

def folder_arns
  @folder_arns
end

#name ⇒ String (readonly)

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

This name displays for the analysis in the Amazon Quick Sight console.

Returns:

  • (String)

See Also:



72
73
74
 
# File 'quick_sight/cfn_analysis_props.rb', line 72

def name
  @name
end

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

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

An analysis can have any parameter type, and some parameters might accept multiple values.

Returns:

See Also:



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

def parameters
  @parameters
end

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

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

You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions .

Returns:

See Also:



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

def permissions
  @permissions
end

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

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

Returns:

See Also:



104
105
106
 
# File 'quick_sight/cfn_analysis_props.rb', line 104

def sheets
  @sheets
end

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

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

This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

See Also:



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

def source_entity
  @source_entity
end

#status ⇒ String? (readonly)

Status associated with the analysis.

Returns:

  • (String, nil)

See Also:



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

def status
  @status
end

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

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

Returns:

See Also:



123
124
125
 
# File 'quick_sight/cfn_analysis_props.rb', line 123

def tags
  @tags
end

#theme_arn ⇒ String? (readonly)

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

To see the theme in the Amazon Quick Sight console, make sure that you have access to it.

Returns:

  • (String, nil)

See Also:



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

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:



137
138
139
 
# File 'quick_sight/cfn_analysis_props.rb', line 137

def validation_strategy
  @validation_strategy
end

Class Method Details

.jsii_properties ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'quick_sight/cfn_analysis_props.rb', line 139

def self.jsii_properties
  {
    :analysis_id => "analysisId",
    :aws_account_id => "awsAccountId",
    :name => "name",
    :definition => "definition",
    :errors => "errors",
    :folder_arns => "folderArns",
    :parameters => "parameters",
    :permissions => "permissions",
    :sheets => "sheets",
    :source_entity => "sourceEntity",
    :status => "status",
    :tags => "tags",
    :theme_arn => "themeArn",
    :validation_strategy => "validationStrategy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'quick_sight/cfn_analysis_props.rb', line 158

def to_jsii
  result = {}
  result.merge!({
    "analysisId" => @analysis_id,
    "awsAccountId" => @aws_account_id,
    "name" => @name,
    "definition" => @definition,
    "errors" => @errors,
    "folderArns" => @folder_arns,
    "parameters" => @parameters,
    "permissions" => @permissions,
    "sheets" => @sheets,
    "sourceEntity" => @source_entity,
    "status" => @status,
    "tags" => @tags,
    "themeArn" => @theme_arn,
    "validationStrategy" => @validation_strategy,
  })
  result.compact
end