Class: AWSCDK::QuickSight::CfnTopic::DefaultFormattingProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTopic::DefaultFormattingProperty

Defined in:

quick_sight/cfn_topic.rb

Overview

A structure that represents a default formatting definition.

See Also:

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

Instance Attribute Summary

• #display_format ⇒ String^? readonly

  The display format.

• #display_format_options ⇒ AWSCDK::IResolvable, ... readonly

  The additional options for display formatting.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(display_format: nil, display_format_options: nil) ⇒ DefaultFormattingProperty constructor

  A new instance of DefaultFormattingProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(display_format: nil, display_format_options: nil) ⇒ DefaultFormattingProperty

Returns a new instance of DefaultFormattingProperty.

Parameters:

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

  The display format.

• display_format_options (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::DisplayFormatOptionsProperty, nil) (defaults to: nil) —

  The additional options for display formatting.

# File 'quick_sight/cfn_topic.rb', line 939

def initialize(display_format: nil, display_format_options: nil)
  @display_format = display_format
  Jsii::Type.check_type(@display_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayFormat") unless @display_format.nil?
  @display_format_options = display_format_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::DisplayFormatOptionsProperty.new(**display_format_options.transform_keys(&:to_sym)) : display_format_options
  Jsii::Type.check_type(@display_format_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLkRpc3BsYXlGb3JtYXRPcHRpb25zUHJvcGVydHkifV19fQ==")), "displayFormatOptions") unless @display_format_options.nil?
end

Instance Attribute Details

#display_format ⇒ String^? (readonly)

The display format.

Valid values for this structure are AUTO , PERCENT , CURRENCY , NUMBER , DATE , and STRING .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html#cfn-quicksight-topic-defaultformatting-displayformat

# File 'quick_sight/cfn_topic.rb', line 952

def display_format
  @display_format
end

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

The additional options for display formatting.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::DisplayFormatOptionsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-defaultformatting.html#cfn-quicksight-topic-defaultformatting-displayformatoptions

# File 'quick_sight/cfn_topic.rb', line 957

def display_format_options
  @display_format_options
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 959

def self.jsii_properties
  {
    :display_format => "displayFormat",
    :display_format_options => "displayFormatOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 966

def to_jsii
  result = {}
  result.merge!({
    "displayFormat" => @display_format,
    "displayFormatOptions" => @display_format_options,
  })
  result.compact
end