Class: AWSCDK::QuickSight::CfnTemplate::StringParameterDeclarationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.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:



25290
25291
25292
25293
25294
25295
25296
25297
25298
25299
25300
25301
 
# File 'quick_sight/cfn_template.rb', line 25290

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::CfnTemplate::StringDefaultValuesProperty.new(**default_values.transform_keys(&:to_sym)) : default_values
  Jsii::Type.check_type(@default_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlN0cmluZ0RlZmF1bHRWYWx1ZXNQcm9wZXJ0eSJ9XX19")), "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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5NYXBwZWREYXRhU2V0UGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "mappedDataSetParameters") unless @mapped_data_set_parameters.nil?
  @value_when_unset = value_when_unset.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::StringValueWhenUnsetConfigurationProperty.new(**value_when_unset.transform_keys(&:to_sym)) : value_when_unset
  Jsii::Type.check_type(@value_when_unset, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlN0cmluZ1ZhbHVlV2hlblVuc2V0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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:



25319
25320
25321
 
# File 'quick_sight/cfn_template.rb', line 25319

def default_values
  @default_values
end

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

Returns:

See Also:



25322
25323
25324
 
# File 'quick_sight/cfn_template.rb', line 25322

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:



25307
25308
25309
 
# File 'quick_sight/cfn_template.rb', line 25307

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:



25312
25313
25314
 
# File 'quick_sight/cfn_template.rb', line 25312

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:



25327
25328
25329
 
# File 'quick_sight/cfn_template.rb', line 25327

def value_when_unset
  @value_when_unset
end

Class Method Details

.jsii_properties ⇒ Object 



25329
25330
25331
25332
25333
25334
25335
25336
25337
 
# File 'quick_sight/cfn_template.rb', line 25329

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 



25339
25340
25341
25342
25343
25344
25345
25346
25347
25348
25349
 
# File 'quick_sight/cfn_template.rb', line 25339

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