Class: AWSCDK::AmplifyUIBuilder::CfnComponent::ActionParametersProperty

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

Overview

Represents the event action configuration for an element of a Component or ComponentChild .

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(anchor: nil, fields: nil, global: nil, id: nil, model: nil, state: nil, target: nil, type: nil, url: nil) ⇒ ActionParametersProperty

Returns a new instance of ActionParametersProperty.

Parameters:



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'amplify_ui_builder/cfn_component.rb', line 706

def initialize(anchor: nil, fields: nil, global: nil, id: nil, model: nil, state: nil, target: nil, type: nil, url: nil)
  @anchor = anchor.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty.new(**anchor.transform_keys(&:to_sym)) : anchor
  Jsii::Type.check_type(@anchor, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "anchor") unless @anchor.nil?
  @fields = fields
  Jsii::Type.check_type(@fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50UHJvcGVydHlQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "fields") unless @fields.nil?
  @global = global.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty.new(**global.transform_keys(&:to_sym)) : global
  Jsii::Type.check_type(@global, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "global") unless @global.nil?
  @id = id.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty.new(**id.transform_keys(&:to_sym)) : id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "id") unless @id.nil?
  @model = model
  Jsii::Type.check_type(@model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "model") unless @model.nil?
  @state = state.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::MutationActionSetStateParameterProperty.new(**state.transform_keys(&:to_sym)) : state
  Jsii::Type.check_type(@state, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5NdXRhdGlvbkFjdGlvblNldFN0YXRlUGFyYW1ldGVyUHJvcGVydHkifV19fQ==")), "state") unless @state.nil?
  @target = target.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty.new(**target.transform_keys(&:to_sym)) : target
  Jsii::Type.check_type(@target, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "target") unless @target.nil?
  @type = type.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty.new(**type.transform_keys(&:to_sym)) : type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "type") unless @type.nil?
  @url = url.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty.new(**url.transform_keys(&:to_sym)) : url
  Jsii::Type.check_type(@url, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "url") unless @url.nil?
end

Instance Attribute Details

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

The HTML anchor link to the location to open.

Specify this value for a navigation action.

Returns:

See Also:



733
734
735
 
# File 'amplify_ui_builder/cfn_component.rb', line 733

def anchor
  @anchor
end

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

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.

Use when the action performs an operation on an Amplify DataStore model.

Returns:

See Also:



740
741
742
 
# File 'amplify_ui_builder/cfn_component.rb', line 740

def fields
  @fields
end

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

Specifies whether the user should be signed out globally.

Specify this value for an auth sign out action.

Returns:

See Also:



747
748
749
 
# File 'amplify_ui_builder/cfn_component.rb', line 747

def global
  @global
end

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

The unique ID of the component that the ActionParameters apply to.

Returns:

See Also:



752
753
754
 
# File 'amplify_ui_builder/cfn_component.rb', line 752

def id
  @id
end

#model ⇒ String? (readonly)

The name of the data model.

Use when the action performs an operation on an Amplify DataStore model.

Returns:

  • (String, nil)

See Also:



759
760
761
 
# File 'amplify_ui_builder/cfn_component.rb', line 759

def model
  @model
end

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

A key-value pair that specifies the state property name and its initial value.

Returns:

See Also:



764
765
766
 
# File 'amplify_ui_builder/cfn_component.rb', line 764

def state
  @state
end

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

The element within the same component to modify when the action occurs.

Returns:

See Also:



769
770
771
 
# File 'amplify_ui_builder/cfn_component.rb', line 769

def target
  @target
end

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

The type of navigation action.

Valid values are url and anchor . This value is required for a navigation action.

Returns:

See Also:



776
777
778
 
# File 'amplify_ui_builder/cfn_component.rb', line 776

def type
  @type
end

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

The URL to the location to open.

Specify this value for a navigation action.

Returns:

See Also:



783
784
785
 
# File 'amplify_ui_builder/cfn_component.rb', line 783

def url
  @url
end

Class Method Details

.jsii_properties ⇒ Object 



785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'amplify_ui_builder/cfn_component.rb', line 785

def self.jsii_properties
  {
    :anchor => "anchor",
    :fields => "fields",
    :global => "global",
    :id => "id",
    :model => "model",
    :state => "state",
    :target => "target",
    :type => "type",
    :url => "url",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'amplify_ui_builder/cfn_component.rb', line 799

def to_jsii
  result = {}
  result.merge!({
    "anchor" => @anchor,
    "fields" => @fields,
    "global" => @global,
    "id" => @id,
    "model" => @model,
    "state" => @state,
    "target" => @target,
    "type" => @type,
    "url" => @url,
  })
  result.compact
end