Class: AWSCDK::QuickSight::CfnTopicProps

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

Overview

Properties for defining a CfnTopic.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aws_account_id: nil, config_options: nil, custom_instructions: nil, data_sets: nil, description: nil, folder_arns: nil, name: nil, tags: nil, topic_id: nil, user_experience_version: nil) ⇒ CfnTopicProps

Returns a new instance of CfnTopicProps.

Parameters:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'quick_sight/cfn_topic_props.rb', line 19

def initialize(aws_account_id: nil, config_options: nil, custom_instructions: nil, data_sets: nil, description: nil, folder_arns: nil, name: nil, tags: nil, topic_id: nil, user_experience_version: nil)
  @aws_account_id = 
  Jsii::Type.check_type(@aws_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsAccountId") unless @aws_account_id.nil?
  @config_options = config_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicConfigOptionsProperty.new(**config_options.transform_keys(&:to_sym)) : config_options
  Jsii::Type.check_type(@config_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljQ29uZmlnT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "configOptions") unless @config_options.nil?
  @custom_instructions = custom_instructions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::CustomInstructionsProperty.new(**custom_instructions.transform_keys(&:to_sym)) : custom_instructions
  Jsii::Type.check_type(@custom_instructions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLkN1c3RvbUluc3RydWN0aW9uc1Byb3BlcnR5In1dfX0=")), "customInstructions") unless @custom_instructions.nil?
  @data_sets = data_sets
  Jsii::Type.check_type(@data_sets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5Ub3BpYy5EYXRhc2V0TWV0YWRhdGFQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dataSets") unless @data_sets.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @folder_arns = folder_arns
  Jsii::Type.check_type(@folder_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "folderArns") unless @folder_arns.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.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?
  @topic_id = topic_id
  Jsii::Type.check_type(@topic_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "topicId") unless @topic_id.nil?
  @user_experience_version = user_experience_version
  Jsii::Type.check_type(@user_experience_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userExperienceVersion") unless @user_experience_version.nil?
end

Instance Attribute Details

#aws_account_id ⇒ String? (readonly)

The ID of the AWS account that you want to create a topic in.

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'quick_sight/cfn_topic_props.rb', line 46

def 
  @aws_account_id
end

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

Configuration options for a Topic .

Returns:

See Also:



51
52
53
 
# File 'quick_sight/cfn_topic_props.rb', line 51

def config_options
  @config_options
end

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

Returns:

See Also:



54
55
56
 
# File 'quick_sight/cfn_topic_props.rb', line 54

def custom_instructions
  @custom_instructions
end

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

The data sets that the topic is associated with.

Returns:

See Also:



59
60
61
 
# File 'quick_sight/cfn_topic_props.rb', line 59

def data_sets
  @data_sets
end

#description ⇒ String? (readonly)

The description of the topic.

Returns:

  • (String, nil)

See Also:



64
65
66
 
# File 'quick_sight/cfn_topic_props.rb', line 64

def description
  @description
end

#folder_arns ⇒ Array<String>? (readonly)

Returns:

  • (Array<String>, nil)

See Also:



67
68
69
 
# File 'quick_sight/cfn_topic_props.rb', line 67

def folder_arns
  @folder_arns
end

#name ⇒ String? (readonly)

The name of the topic.

Returns:

  • (String, nil)

See Also:



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

def name
  @name
end

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

Returns:

See Also:



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

def tags
  @tags
end

#topic_id ⇒ String? (readonly)

The ID for the topic.

This ID is unique per AWS Region for each AWS account.

Returns:

  • (String, nil)

See Also:



82
83
84
 
# File 'quick_sight/cfn_topic_props.rb', line 82

def topic_id
  @topic_id
end

#user_experience_version ⇒ String? (readonly)

The user experience version of the topic.

Returns:

  • (String, nil)

See Also:



87
88
89
 
# File 'quick_sight/cfn_topic_props.rb', line 87

def user_experience_version
  @user_experience_version
end

Class Method Details

.jsii_properties ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'quick_sight/cfn_topic_props.rb', line 89

def self.jsii_properties
  {
    :aws_account_id => "awsAccountId",
    :config_options => "configOptions",
    :custom_instructions => "customInstructions",
    :data_sets => "dataSets",
    :description => "description",
    :folder_arns => "folderArns",
    :name => "name",
    :tags => "tags",
    :topic_id => "topicId",
    :user_experience_version => "userExperienceVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'quick_sight/cfn_topic_props.rb', line 104

def to_jsii
  result = {}
  result.merge!({
    "awsAccountId" => @aws_account_id,
    "configOptions" => @config_options,
    "customInstructions" => @custom_instructions,
    "dataSets" => @data_sets,
    "description" => @description,
    "folderArns" => @folder_arns,
    "name" => @name,
    "tags" => @tags,
    "topicId" => @topic_id,
    "userExperienceVersion" => @user_experience_version,
  })
  result.compact
end