Class: Aws::AmplifyUIBuilder::Types::CreateComponentData

Inherits:

Struct

• Object
• Struct
• Aws::AmplifyUIBuilder::Types::CreateComponentData

Includes:

Structure

Defined in:

lib/aws-sdk-amplifyuibuilder/types.rb

Overview

Represents all of the information that is required to create a component.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

  The data binding information for the component’s properties.

• #children ⇒ Array<Types::ComponentChild>

  A list of child components that are instances of the main component.

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

  The data binding configuration for customizing a component’s properties.

• #component_type ⇒ String

  The component type.

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

  The event configuration for the component.

• #name ⇒ String

  The name of the component.

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

  Describes the component properties that can be overriden to customize an 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 data.

• #variants ⇒ Array<Types::ComponentVariant>

  A list of the unique variants of this component.

Instance Attribute Details

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

The data binding information for the component’s properties.

Returns:

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

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

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

#children ⇒ Array<Types::ComponentChild>

A list of child components that are instances of the main component.

Returns:

• (Array<Types::ComponentChild>)

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

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

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

The data binding configuration for customizing a component’s properties. Use this for a collection component.

Returns:

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

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

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

#component_type ⇒ String

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

Returns:

• (String)

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

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

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

The event configuration for 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 1076

class CreateComponentData < Struct.new(
  :name,
  :source_id,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :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 1076

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

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

Describes the component properties that can be overriden to customize an instance of the component.

Returns:

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

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

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

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

Describes the component’s properties.

Returns:

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

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

class CreateComponentData < Struct.new(
  :name,
  :source_id,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :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 1076

class CreateComponentData < Struct.new(
  :name,
  :source_id,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :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 1076

class CreateComponentData < Struct.new(
  :name,
  :source_id,
  :component_type,
  :properties,
  :children,
  :variants,
  :overrides,
  :binding_properties,
  :collection_properties,
  :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 data.

Returns:

• (Hash<String,String>)

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

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

#variants ⇒ Array<Types::ComponentVariant>

A list of the unique variants of this component.

Returns:

• (Array<Types::ComponentVariant>)

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

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