Class: AWSCDK::QuickSight::CfnDashboard::StringValueWhenUnsetConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::StringValueWhenUnsetConfigurationProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The configuration that defines the default value of a String parameter when a value has not been set.

See Also:

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

Instance Attribute Summary

• #custom_value ⇒ String^? readonly

  A custom value that's used when the value of a parameter isn't set.

• #value_when_unset_option ⇒ String^? readonly

  The built-in options for default values.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(custom_value: nil, value_when_unset_option: nil) ⇒ StringValueWhenUnsetConfigurationProperty constructor

  A new instance of StringValueWhenUnsetConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(custom_value: nil, value_when_unset_option: nil) ⇒ StringValueWhenUnsetConfigurationProperty

Returns a new instance of StringValueWhenUnsetConfigurationProperty.

Parameters:

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

  A custom value that's used when the value of a parameter isn't set.

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

  The built-in options for default values. The value can be one of the following:.

# File 'quick_sight/cfn_dashboard.rb', line 28530

def initialize(custom_value: nil, value_when_unset_option: nil)
  @custom_value = custom_value
  Jsii::Type.check_type(@custom_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customValue") unless @custom_value.nil?
  @value_when_unset_option = value_when_unset_option
  Jsii::Type.check_type(@value_when_unset_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "valueWhenUnsetOption") unless @value_when_unset_option.nil?
end

Instance Attribute Details

#custom_value ⇒ String^? (readonly)

A custom value that's used when the value of a parameter isn't set.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-stringvaluewhenunsetconfiguration-customvalue

# File 'quick_sight/cfn_dashboard.rb', line 28541

def custom_value
  @custom_value
end

#value_when_unset_option ⇒ String^? (readonly)

The built-in options for default values. The value can be one of the following:.

• RECOMMENDED : The recommended value.
• NULL : The NULL value.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-stringvaluewhenunsetconfiguration-valuewhenunsetoption

# File 'quick_sight/cfn_dashboard.rb', line 28549

def value_when_unset_option
  @value_when_unset_option
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 28551

def self.jsii_properties
  {
    :custom_value => "customValue",
    :value_when_unset_option => "valueWhenUnsetOption",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 28558

def to_jsii
  result = {}
  result.merge!({
    "customValue" => @custom_value,
    "valueWhenUnsetOption" => @value_when_unset_option,
  })
  result.compact
end