Class: AWSCDK::AmplifyUIBuilder::CfnForm::FieldInputConfigProperty

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

Overview

The FieldInputConfig property specifies the configuration for the default input values to display for a field.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, default_checked: nil, default_country_code: nil, default_value: nil, descriptive_text: nil, file_uploader_config: nil, is_array: nil, max_value: nil, min_value: nil, name: nil, placeholder: nil, read_only: nil, required: nil, step: nil, value: nil, value_mappings: nil) ⇒ FieldInputConfigProperty

Returns a new instance of FieldInputConfigProperty.

Parameters:

  • type (String) —

    The input type for the field.

  • default_checked (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether a field has a default value.

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

    The default country code for a phone number.

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

    The default value for the field.

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

    The text to display to describe the field.

  • file_uploader_config (AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnForm::FileUploaderFieldConfigProperty, nil) (defaults to: nil) —

    The configuration for the file uploader field.

  • is_array (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to render the field as an array.

  • max_value (Numeric, nil) (defaults to: nil) —

    The maximum value to display for the field.

  • min_value (Numeric, nil) (defaults to: nil) —

    The minimum value to display for the field.

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

    The name of the field.

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

    The text to display as a placeholder for the field.

  • read_only (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies a read only field.

  • required (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies a field that requires input.

  • step (Numeric, nil) (defaults to: nil) —

    The stepping increment for a numeric value in a field.

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

    The value for the field.

  • value_mappings (AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnForm::ValueMappingsProperty, nil) (defaults to: nil) —

    The information to use to customize the input fields with data at runtime.



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'amplify_ui_builder/cfn_form.rb', line 743

def initialize(type:, default_checked: nil, default_country_code: nil, default_value: nil, descriptive_text: nil, file_uploader_config: nil, is_array: nil, max_value: nil, min_value: nil, name: nil, placeholder: nil, read_only: nil, required: nil, step: nil, value: nil, value_mappings: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @default_checked = default_checked
  Jsii::Type.check_type(@default_checked, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "defaultChecked") unless @default_checked.nil?
  @default_country_code = default_country_code
  Jsii::Type.check_type(@default_country_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultCountryCode") unless @default_country_code.nil?
  @default_value = default_value
  Jsii::Type.check_type(@default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless @default_value.nil?
  @descriptive_text = descriptive_text
  Jsii::Type.check_type(@descriptive_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "descriptiveText") unless @descriptive_text.nil?
  @file_uploader_config = file_uploader_config.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnForm::FileUploaderFieldConfigProperty.new(**file_uploader_config.transform_keys(&:to_sym)) : file_uploader_config
  Jsii::Type.check_type(@file_uploader_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkZvcm0uRmlsZVVwbG9hZGVyRmllbGRDb25maWdQcm9wZXJ0eSJ9XX19")), "fileUploaderConfig") unless @file_uploader_config.nil?
  @is_array = is_array
  Jsii::Type.check_type(@is_array, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isArray") unless @is_array.nil?
  @max_value = max_value
  Jsii::Type.check_type(@max_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxValue") unless @max_value.nil?
  @min_value = min_value
  Jsii::Type.check_type(@min_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minValue") unless @min_value.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @placeholder = placeholder
  Jsii::Type.check_type(@placeholder, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "placeholder") unless @placeholder.nil?
  @read_only = read_only
  Jsii::Type.check_type(@read_only, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "readOnly") unless @read_only.nil?
  @required = required
  Jsii::Type.check_type(@required, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "required") unless @required.nil?
  @step = step
  Jsii::Type.check_type(@step, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "step") unless @step.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
  @value_mappings = value_mappings.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnForm::ValueMappingsProperty.new(**value_mappings.transform_keys(&:to_sym)) : value_mappings
  Jsii::Type.check_type(@value_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkZvcm0uVmFsdWVNYXBwaW5nc1Byb3BlcnR5In1dfX0=")), "valueMappings") unless @value_mappings.nil?
end

Instance Attribute Details

#default_checked ⇒ Boolean, ... (readonly)

Specifies whether a field has a default value.

Returns:

See Also:



787
788
789
 
# File 'amplify_ui_builder/cfn_form.rb', line 787

def default_checked
  @default_checked
end

#default_country_code ⇒ String? (readonly)

The default country code for a phone number.

Returns:

  • (String, nil)

See Also:



792
793
794
 
# File 'amplify_ui_builder/cfn_form.rb', line 792

def default_country_code
  @default_country_code
end

#default_value ⇒ String? (readonly)

The default value for the field.

Returns:

  • (String, nil)

See Also:



797
798
799
 
# File 'amplify_ui_builder/cfn_form.rb', line 797

def default_value
  @default_value
end

#descriptive_text ⇒ String? (readonly)

The text to display to describe the field.

Returns:

  • (String, nil)

See Also:



802
803
804
 
# File 'amplify_ui_builder/cfn_form.rb', line 802

def descriptive_text
  @descriptive_text
end

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

The configuration for the file uploader field.

Returns:

See Also:



807
808
809
 
# File 'amplify_ui_builder/cfn_form.rb', line 807

def file_uploader_config
  @file_uploader_config
end

#is_array ⇒ Boolean, ... (readonly)

Specifies whether to render the field as an array.

This property is ignored if the data_source_type for the form is a Data Store.

Returns:

See Also:



814
815
816
 
# File 'amplify_ui_builder/cfn_form.rb', line 814

def is_array
  @is_array
end

#max_value ⇒ Numeric? (readonly)

The maximum value to display for the field.

Returns:

  • (Numeric, nil)

See Also:



819
820
821
 
# File 'amplify_ui_builder/cfn_form.rb', line 819

def max_value
  @max_value
end

#min_value ⇒ Numeric? (readonly)

The minimum value to display for the field.

Returns:

  • (Numeric, nil)

See Also:



824
825
826
 
# File 'amplify_ui_builder/cfn_form.rb', line 824

def min_value
  @min_value
end

#name ⇒ String? (readonly)

The name of the field.

Returns:

  • (String, nil)

See Also:



829
830
831
 
# File 'amplify_ui_builder/cfn_form.rb', line 829

def name
  @name
end

#placeholder ⇒ String? (readonly)

The text to display as a placeholder for the field.

Returns:

  • (String, nil)

See Also:



834
835
836
 
# File 'amplify_ui_builder/cfn_form.rb', line 834

def placeholder
  @placeholder
end

#read_only ⇒ Boolean, ... (readonly)

Specifies a read only field.

Returns:

See Also:



839
840
841
 
# File 'amplify_ui_builder/cfn_form.rb', line 839

def read_only
  @read_only
end

#required ⇒ Boolean, ... (readonly)

Specifies a field that requires input.

Returns:

See Also:



844
845
846
 
# File 'amplify_ui_builder/cfn_form.rb', line 844

def required
  @required
end

#step ⇒ Numeric? (readonly)

The stepping increment for a numeric value in a field.

Returns:

  • (Numeric, nil)

See Also:



849
850
851
 
# File 'amplify_ui_builder/cfn_form.rb', line 849

def step
  @step
end

#type ⇒ String (readonly)

The input type for the field.

Returns:

  • (String)

See Also:



782
783
784
 
# File 'amplify_ui_builder/cfn_form.rb', line 782

def type
  @type
end

#value ⇒ String? (readonly)

The value for the field.

Returns:

  • (String, nil)

See Also:



854
855
856
 
# File 'amplify_ui_builder/cfn_form.rb', line 854

def value
  @value
end

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

The information to use to customize the input fields with data at runtime.

Returns:

See Also:



859
860
861
 
# File 'amplify_ui_builder/cfn_form.rb', line 859

def value_mappings
  @value_mappings
end

Class Method Details

.jsii_properties ⇒ Object 



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'amplify_ui_builder/cfn_form.rb', line 861

def self.jsii_properties
  {
    :type => "type",
    :default_checked => "defaultChecked",
    :default_country_code => "defaultCountryCode",
    :default_value => "defaultValue",
    :descriptive_text => "descriptiveText",
    :file_uploader_config => "fileUploaderConfig",
    :is_array => "isArray",
    :max_value => "maxValue",
    :min_value => "minValue",
    :name => "name",
    :placeholder => "placeholder",
    :read_only => "readOnly",
    :required => "required",
    :step => "step",
    :value => "value",
    :value_mappings => "valueMappings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'amplify_ui_builder/cfn_form.rb', line 882

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "defaultChecked" => @default_checked,
    "defaultCountryCode" => @default_country_code,
    "defaultValue" => @default_value,
    "descriptiveText" => @descriptive_text,
    "fileUploaderConfig" => @file_uploader_config,
    "isArray" => @is_array,
    "maxValue" => @max_value,
    "minValue" => @min_value,
    "name" => @name,
    "placeholder" => @placeholder,
    "readOnly" => @read_only,
    "required" => @required,
    "step" => @step,
    "value" => @value,
    "valueMappings" => @value_mappings,
  })
  result.compact
end