Class: AWSCDK::QuickSight::CfnDashboard::StringParameterDeclarationProperty

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

Overview

A parameter declaration for the String data type.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, parameter_value_type:, default_values: nil, mapped_data_set_parameters: nil, value_when_unset: nil) ⇒ StringParameterDeclarationProperty

Returns a new instance of StringParameterDeclarationProperty.

Parameters:



28417
28418
28419
28420
28421
28422
28423
28424
28425
28426
28427
28428
 
# File 'quick_sight/cfn_dashboard.rb', line 28417

def initialize(name:, parameter_value_type:, default_values: nil, mapped_data_set_parameters: nil, value_when_unset: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @parameter_value_type = parameter_value_type
  Jsii::Type.check_type(@parameter_value_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterValueType")
  @default_values = default_values.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::StringDefaultValuesProperty.new(**default_values.transform_keys(&:to_sym)) : default_values
  Jsii::Type.check_type(@default_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TdHJpbmdEZWZhdWx0VmFsdWVzUHJvcGVydHkifV19fQ==")), "defaultValues") unless @default_values.nil?
  @mapped_data_set_parameters = mapped_data_set_parameters
  Jsii::Type.check_type(@mapped_data_set_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuTWFwcGVkRGF0YVNldFBhcmFtZXRlclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "mappedDataSetParameters") unless @mapped_data_set_parameters.nil?
  @value_when_unset = value_when_unset.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::StringValueWhenUnsetConfigurationProperty.new(**value_when_unset.transform_keys(&:to_sym)) : value_when_unset
  Jsii::Type.check_type(@value_when_unset, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TdHJpbmdWYWx1ZVdoZW5VbnNldENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "valueWhenUnset") unless @value_when_unset.nil?
end

Instance Attribute Details

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

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

Returns:

See Also:



28446
28447
28448
 
# File 'quick_sight/cfn_dashboard.rb', line 28446

def default_values
  @default_values
end

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

Returns:

See Also:



28449
28450
28451
 
# File 'quick_sight/cfn_dashboard.rb', line 28449

def mapped_data_set_parameters
  @mapped_data_set_parameters
end

#name ⇒ String (readonly)

The name of the parameter that is being declared.

Returns:

  • (String)

See Also:



28434
28435
28436
 
# File 'quick_sight/cfn_dashboard.rb', line 28434

def name
  @name
end

#parameter_value_type ⇒ String (readonly)

The value type determines whether the parameter is a single-value or multi-value parameter.

Returns:

  • (String)

See Also:



28439
28440
28441
 
# File 'quick_sight/cfn_dashboard.rb', line 28439

def parameter_value_type
  @parameter_value_type
end

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

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

Returns:

See Also:



28454
28455
28456
 
# File 'quick_sight/cfn_dashboard.rb', line 28454

def value_when_unset
  @value_when_unset
end

Class Method Details

.jsii_properties ⇒ Object 



28456
28457
28458
28459
28460
28461
28462
28463
28464
 
# File 'quick_sight/cfn_dashboard.rb', line 28456

def self.jsii_properties
  {
    :name => "name",
    :parameter_value_type => "parameterValueType",
    :default_values => "defaultValues",
    :mapped_data_set_parameters => "mappedDataSetParameters",
    :value_when_unset => "valueWhenUnset",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



28466
28467
28468
28469
28470
28471
28472
28473
28474
28475
28476
 
# File 'quick_sight/cfn_dashboard.rb', line 28466

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "parameterValueType" => @parameter_value_type,
    "defaultValues" => @default_values,
    "mappedDataSetParameters" => @mapped_data_set_parameters,
    "valueWhenUnset" => @value_when_unset,
  })
  result.compact
end