Class: Aws::AmplifyUIBuilder::Types::Component

Inherits:

Struct

• Object
• Struct
• Aws::AmplifyUIBuilder::Types::Component

Includes:

Structure

Defined in:

lib/aws-sdk-amplifyuibuilder/types.rb

Overview

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ‘ComponentChild` to configure an instance of a `Component`. A `ComponentChild` instance inherits the configuration of the main `Component`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_id ⇒ String

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

• #binding_properties ⇒ Hash<String,Types::ComponentBindingPropertiesValue>

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

• #children ⇒ Array<Types::ComponentChild>

  A list of the component’s ‘ComponentChild` instances.

• #collection_properties ⇒ Hash<String,Types::ComponentDataConfiguration>

  The data binding configuration for the component’s properties.

• #component_type ⇒ String

  The type of the component.

• #created_at ⇒ Time

  The time that the component was created.

• #environment_name ⇒ String

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

• #events ⇒ Hash<String,Types::ComponentEvent>

  Describes the events that can be raised on the component.

• #id ⇒ String

  The unique ID of the component.

• #modified_at ⇒ Time

  The time that the component was modified.

• #name ⇒ String

  The name of the component.

• #overrides ⇒ Hash<String,Hash<String,String>>

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

• #properties ⇒ Hash<String,Types::ComponentProperty>

  Describes the component’s properties.

• #schema_version ⇒ String

  The schema version of the component when it was imported.

• #source_id ⇒ String

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

• #tags ⇒ Hash<String,String>

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

• #variants ⇒ Array<Types::ComponentVariant>

  A list of the component’s variants.

Instance Attribute Details

#app_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#binding_properties ⇒ Hash<String,Types::ComponentBindingPropertiesValue>

The information to connect a component’s properties to data at runtime. You can’t specify ‘tags` as a valid property for `bindingProperties`.

Returns:

• (Hash<String,Types::ComponentBindingPropertiesValue>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#children ⇒ Array<Types::ComponentChild>

A list of the component’s ‘ComponentChild` instances.

Returns:

• (Array<Types::ComponentChild>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#collection_properties ⇒ Hash<String,Types::ComponentDataConfiguration>

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 `collectionProperties`.

Returns:

• (Hash<String,Types::ComponentDataConfiguration>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#component_type ⇒ String

The type of the component. This can be an Amplify custom UI component or another custom component.

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time that the component was created.

Returns:

• (Time)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#events ⇒ Hash<String,Types::ComponentEvent>

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:

• (Hash<String,Types::ComponentEvent>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique ID of the component.

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ Time

The time that the component was modified.

Returns:

• (Time)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the component.

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#overrides ⇒ Hash<String,Hash<String,String>>

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:

• (Hash<String,Hash<String,String>>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#properties ⇒ Hash<String,Types::ComponentProperty>

Describes the component’s properties. You can’t specify ‘tags` as a valid property for `properties`.

Returns:

• (Hash<String,Types::ComponentProperty>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#schema_version ⇒ String

The schema version of the component when it was imported.

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#source_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#variants ⇒ Array<Types::ComponentVariant>

A list of the component’s variants. A variant is a unique style configuration of a main component.

Returns:

• (Array<Types::ComponentVariant>)

# File 'lib/aws-sdk-amplifyuibuilder/types.rb', line 591

class Component < Struct.new(
  :app_id,
  :environment_name,
  :source_id,
  :id,
  :name,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :created_at,
  :modified_at,
  :tags,
  :events,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end