Class: AWSCDK::AmplifyUIBuilder::CfnForm::FieldConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
amplify_ui_builder/cfn_form.rb

Overview

The FieldConfig property specifies the configuration information for a field in a table.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(excluded: nil, input_type: nil, label: nil, position: nil, validations: nil) ⇒ FieldConfigProperty

Returns a new instance of FieldConfigProperty.

Parameters:



659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'amplify_ui_builder/cfn_form.rb', line 659

def initialize(excluded: nil, input_type: nil, label: nil, position: nil, validations: nil)
  @excluded = excluded
  Jsii::Type.check_type(@excluded, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "excluded") unless @excluded.nil?
  @input_type = input_type.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnForm::FieldInputConfigProperty.new(**input_type.transform_keys(&:to_sym)) : input_type
  Jsii::Type.check_type(@input_type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkZvcm0uRmllbGRJbnB1dENvbmZpZ1Byb3BlcnR5In1dfX0=")), "inputType") unless @input_type.nil?
  @label = label
  Jsii::Type.check_type(@label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "label") unless @label.nil?
  @position = position.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnForm::FieldPositionProperty.new(**position.transform_keys(&:to_sym)) : position
  Jsii::Type.check_type(@position, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkZvcm0uRmllbGRQb3NpdGlvblByb3BlcnR5In1dfX0=")), "position") unless @position.nil?
  @validations = validations
  Jsii::Type.check_type(@validations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Gb3JtLkZpZWxkVmFsaWRhdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "validations") unless @validations.nil?
end

Instance Attribute Details

#excluded ⇒ Boolean, ... (readonly)

Specifies whether to hide a field.

Returns:

See Also:



676
677
678
 
# File 'amplify_ui_builder/cfn_form.rb', line 676

def excluded
  @excluded
end

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

Describes the configuration for the default input value to display for a field.

Returns:

See Also:



681
682
683
 
# File 'amplify_ui_builder/cfn_form.rb', line 681

def input_type
  @input_type
end

#label ⇒ String? (readonly)

The label for the field.

Returns:

  • (String, nil)

See Also:



686
687
688
 
# File 'amplify_ui_builder/cfn_form.rb', line 686

def label
  @label
end

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

Specifies the field position.

Returns:

See Also:



691
692
693
 
# File 'amplify_ui_builder/cfn_form.rb', line 691

def position
  @position
end

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

The validations to perform on the value in the field.

Returns:

See Also:



696
697
698
 
# File 'amplify_ui_builder/cfn_form.rb', line 696

def validations
  @validations
end

Class Method Details

.jsii_properties ⇒ Object 



698
699
700
701
702
703
704
705
706
 
# File 'amplify_ui_builder/cfn_form.rb', line 698

def self.jsii_properties
  {
    :excluded => "excluded",
    :input_type => "inputType",
    :label => "label",
    :position => "position",
    :validations => "validations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



708
709
710
711
712
713
714
715
716
717
718
 
# File 'amplify_ui_builder/cfn_form.rb', line 708

def to_jsii
  result = {}
  result.merge!({
    "excluded" => @excluded,
    "inputType" => @input_type,
    "label" => @label,
    "position" => @position,
    "validations" => @validations,
  })
  result.compact
end