Class: AWSCDK::QuickSight::CfnDashboard::VisualCustomActionProperty

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

Overview

A custom action defined on a visual.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_operations:, custom_action_id:, name:, trigger:, status: nil) ⇒ VisualCustomActionProperty

Returns a new instance of VisualCustomActionProperty.

Parameters:



32072
32073
32074
32075
32076
32077
32078
32079
32080
32081
32082
32083
 
# File 'quick_sight/cfn_dashboard.rb', line 32072

def initialize(action_operations:, custom_action_id:, name:, trigger:, status: nil)
  @action_operations = action_operations
  Jsii::Type.check_type(@action_operations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuVmlzdWFsQ3VzdG9tQWN0aW9uT3BlcmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "actionOperations")
  @custom_action_id = custom_action_id
  Jsii::Type.check_type(@custom_action_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customActionId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @trigger = trigger
  Jsii::Type.check_type(@trigger, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trigger")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#action_operations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::VisualCustomActionOperationProperty> (readonly)

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Returns:

See Also:



32091
32092
32093
 
# File 'quick_sight/cfn_dashboard.rb', line 32091

def action_operations
  @action_operations
end

#custom_action_id ⇒ String (readonly)

The ID of the VisualCustomAction .

Returns:

  • (String)

See Also:



32096
32097
32098
 
# File 'quick_sight/cfn_dashboard.rb', line 32096

def custom_action_id
  @custom_action_id
end

#name ⇒ String (readonly)

The name of the VisualCustomAction .

Returns:

  • (String)

See Also:



32101
32102
32103
 
# File 'quick_sight/cfn_dashboard.rb', line 32101

def name
  @name
end

#status ⇒ String? (readonly)

The status of the VisualCustomAction .

Returns:

  • (String, nil)

See Also:



32116
32117
32118
 
# File 'quick_sight/cfn_dashboard.rb', line 32116

def status
  @status
end

#trigger ⇒ String (readonly)

The trigger of the VisualCustomAction .

Valid values are defined as follows:

  • DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
  • DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Returns:

  • (String)

See Also:



32111
32112
32113
 
# File 'quick_sight/cfn_dashboard.rb', line 32111

def trigger
  @trigger
end

Class Method Details

.jsii_properties ⇒ Object 



32118
32119
32120
32121
32122
32123
32124
32125
32126
 
# File 'quick_sight/cfn_dashboard.rb', line 32118

def self.jsii_properties
  {
    :action_operations => "actionOperations",
    :custom_action_id => "customActionId",
    :name => "name",
    :trigger => "trigger",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32128
32129
32130
32131
32132
32133
32134
32135
32136
32137
32138
 
# File 'quick_sight/cfn_dashboard.rb', line 32128

def to_jsii
  result = {}
  result.merge!({
    "actionOperations" => @action_operations,
    "customActionId" => @custom_action_id,
    "name" => @name,
    "trigger" => @trigger,
    "status" => @status,
  })
  result.compact
end