Class: AWSCDK::AmplifyUIBuilder::CfnComponentProps

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

Overview

Properties for defining a CfnComponent.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_id: nil, binding_properties: nil, children: nil, collection_properties: nil, component_type: nil, environment_name: nil, events: nil, name: nil, overrides: nil, properties: nil, schema_version: nil, source_id: nil, tags: nil, variants: nil) ⇒ CfnComponentProps

Returns a new instance of CfnComponentProps.

Parameters:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 23

def initialize(app_id: nil, binding_properties: nil, children: nil, collection_properties: nil, component_type: nil, environment_name: nil, events: nil, name: nil, overrides: nil, properties: nil, schema_version: nil, source_id: nil, tags: nil, variants: nil)
  @app_id = app_id
  Jsii::Type.check_type(@app_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appId") unless @app_id.nil?
  @binding_properties = binding_properties
  Jsii::Type.check_type(@binding_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50QmluZGluZ1Byb3BlcnRpZXNWYWx1ZVByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "bindingProperties") unless @binding_properties.nil?
  @children = children
  Jsii::Type.check_type(@children, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50Q2hpbGRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "children") unless @children.nil?
  @collection_properties = collection_properties
  Jsii::Type.check_type(@collection_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50RGF0YUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "collectionProperties") unless @collection_properties.nil?
  @component_type = component_type
  Jsii::Type.check_type(@component_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentType") unless @component_type.nil?
  @environment_name = environment_name
  Jsii::Type.check_type(@environment_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentName") unless @environment_name.nil?
  @events = events
  Jsii::Type.check_type(@events, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50RXZlbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "events") unless @events.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @overrides = overrides
  Jsii::Type.check_type(@overrides, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "overrides") unless @overrides.nil?
  @properties = properties
  Jsii::Type.check_type(@properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50UHJvcGVydHlQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "properties") unless @properties.nil?
  @schema_version = schema_version
  Jsii::Type.check_type(@schema_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "schemaVersion") unless @schema_version.nil?
  @source_id = source_id
  Jsii::Type.check_type(@source_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceId") unless @source_id.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @variants = variants
  Jsii::Type.check_type(@variants, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50VmFyaWFudFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "variants") unless @variants.nil?
end

Instance Attribute Details

#app_id ⇒ String? (readonly)

The unique ID of the Amplify app associated with the component.

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 58

def app_id
  @app_id
end

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

The information to connect a component's properties to data at runtime.

You can't specify tags as a valid property for binding_properties .

Returns:

See Also:



65
66
67
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 65

def binding_properties
  @binding_properties
end

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

A list of the component's ComponentChild instances.

Returns:

See Also:



70
71
72
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 70

def children
  @children
end

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

The data binding configuration for the component's properties.

Use this for a collection component. You can't specify tags as a valid property for collection_properties .

Returns:

See Also:



77
78
79
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 77

def collection_properties
  @collection_properties
end

#component_type ⇒ String? (readonly)

The type of the component.

This can be an Amplify custom UI component or another custom component.

Returns:

  • (String, nil)

See Also:



84
85
86
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 84

def component_type
  @component_type
end

#environment_name ⇒ String? (readonly)

The name of the backend environment that is a part of the Amplify app.

Returns:

  • (String, nil)

See Also:



89
90
91
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 89

def environment_name
  @environment_name
end

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

Describes the events that can be raised on the component.

Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

Returns:

See Also:



96
97
98
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 96

def events
  @events
end

#name ⇒ String? (readonly)

The name of the component.

Returns:

  • (String, nil)

See Also:



101
102
103
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 101

def name
  @name
end

#overrides ⇒ Object? (readonly)

Describes the component's properties that can be overriden in a customized instance of the component.

You can't specify tags as a valid property for overrides .

Returns:

  • (Object, nil)

See Also:



108
109
110
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 108

def overrides
  @overrides
end

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

Describes the component's properties.

You can't specify tags as a valid property for properties .

Returns:

See Also:



115
116
117
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 115

def properties
  @properties
end

#schema_version ⇒ String? (readonly)

The schema version of the component when it was imported.

Returns:

  • (String, nil)

See Also:



120
121
122
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 120

def schema_version
  @schema_version
end

#source_id ⇒ String? (readonly)

The unique ID of the component in its original source system, such as Figma.

Returns:

  • (String, nil)

See Also:



125
126
127
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 125

def source_id
  @source_id
end

#tags ⇒ Hash{String => String}? (readonly)

One or more key-value pairs to use when tagging the component.

Returns:

  • (Hash{String => String}, nil)

See Also:



130
131
132
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 130

def tags
  @tags
end

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

A list of the component's variants.

A variant is a unique style configuration of a main component.

Returns:

See Also:



137
138
139
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 137

def variants
  @variants
end

Class Method Details

.jsii_properties ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 139

def self.jsii_properties
  {
    :app_id => "appId",
    :binding_properties => "bindingProperties",
    :children => "children",
    :collection_properties => "collectionProperties",
    :component_type => "componentType",
    :environment_name => "environmentName",
    :events => "events",
    :name => "name",
    :overrides => "overrides",
    :properties => "properties",
    :schema_version => "schemaVersion",
    :source_id => "sourceId",
    :tags => "tags",
    :variants => "variants",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'amplify_ui_builder/cfn_component_props.rb', line 158

def to_jsii
  result = {}
  result.merge!({
    "appId" => @app_id,
    "bindingProperties" => @binding_properties,
    "children" => @children,
    "collectionProperties" => @collection_properties,
    "componentType" => @component_type,
    "environmentName" => @environment_name,
    "events" => @events,
    "name" => @name,
    "overrides" => @overrides,
    "properties" => @properties,
    "schemaVersion" => @schema_version,
    "sourceId" => @source_id,
    "tags" => @tags,
    "variants" => @variants,
  })
  result.compact
end