Class: AWSCDK::QuickSight::CfnTemplate::VisualCustomActionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::VisualCustomActionProperty

Defined in:

quick_sight/cfn_template.rb

Overview

A custom action defined on a visual.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html

Instance Attribute Summary

• #action_operations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::VisualCustomActionOperationProperty> readonly

  A list of VisualCustomActionOperations .

• #custom_action_id ⇒ String readonly

  The ID of the VisualCustomAction .

• #name ⇒ String readonly

  The name of the VisualCustomAction .

• #status ⇒ String^? readonly

  The status of the VisualCustomAction .

• #trigger ⇒ String readonly

  The trigger of the VisualCustomAction .

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

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

  A new instance of VisualCustomActionProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of VisualCustomActionProperty.

Parameters:

• action_operations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::VisualCustomActionOperationProperty>) —

  A list of VisualCustomActionOperations .

• custom_action_id (String) —

  The ID of the VisualCustomAction .

• name (String) —

  The name of the VisualCustomAction .

• trigger (String) —

  The trigger of the VisualCustomAction .

• status (String, nil) (defaults to: nil) —

  The status of the VisualCustomAction .

# File 'quick_sight/cfn_template.rb', line 29283

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5WaXN1YWxDdXN0b21BY3Rpb25PcGVyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "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::CfnTemplate::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:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::VisualCustomActionOperationProperty>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-actionoperations

# File 'quick_sight/cfn_template.rb', line 29302

def action_operations
  @action_operations
end

#custom_action_id ⇒ String (readonly)

The ID of the VisualCustomAction .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-customactionid

# File 'quick_sight/cfn_template.rb', line 29307

def custom_action_id
  @custom_action_id
end

#name ⇒ String (readonly)

The name of the VisualCustomAction .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-name

# File 'quick_sight/cfn_template.rb', line 29312

def name
  @name
end

#status ⇒ String^? (readonly)

The status of the VisualCustomAction .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-status

# File 'quick_sight/cfn_template.rb', line 29327

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-trigger

# File 'quick_sight/cfn_template.rb', line 29322

def trigger
  @trigger
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 29329

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

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 29339

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