software.amazon.awssdk.services.amplifyuibuilder.model

Interface CreateComponentData.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CreateComponentData.Builder,CreateComponentData>, SdkBuilder<CreateComponentData.Builder,CreateComponentData>, SdkPojo

Enclosing class:

CreateComponentData

public static interface CreateComponentData.Builder
extends SdkPojo, CopyableBuilder<CreateComponentData.Builder,CreateComponentData>

Method Summary

Modifier and Type	Method and Description
CreateComponentData.Builder	bindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties) The data binding information for the component's properties.
CreateComponentData.Builder	children(Collection<ComponentChild> children) A list of child components that are instances of the main component.
CreateComponentData.Builder	children(ComponentChild... children) A list of child components that are instances of the main component.
CreateComponentData.Builder	children(Consumer<ComponentChild.Builder>... children) A list of child components that are instances of the main component.
CreateComponentData.Builder	collectionProperties(Map<String,ComponentDataConfiguration> collectionProperties) The data binding configuration for customizing a component's properties.
CreateComponentData.Builder	componentType(String componentType) The component type.
CreateComponentData.Builder	events(Map<String,ComponentEvent> events) The event configuration for the component.
CreateComponentData.Builder	name(String name) The name of the component
CreateComponentData.Builder	overrides(Map<String,? extends Map<String,String>> overrides) Describes the component properties that can be overriden to customize an instance of the component.
CreateComponentData.Builder	properties(Map<String,ComponentProperty> properties) Describes the component's properties.
CreateComponentData.Builder	schemaVersion(String schemaVersion) The schema version of the component when it was imported.
CreateComponentData.Builder	sourceId(String sourceId) The unique ID of the component in its original source system, such as Figma.
CreateComponentData.Builder	tags(Map<String,String> tags) One or more key-value pairs to use when tagging the component data.
CreateComponentData.Builder	variants(Collection<ComponentVariant> variants) A list of the unique variants of this component.
CreateComponentData.Builder	variants(ComponentVariant... variants) A list of the unique variants of this component.
CreateComponentData.Builder	variants(Consumer<ComponentVariant.Builder>... variants) A list of the unique variants of this component.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

bindingProperties

CreateComponentData.Builder bindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)

The data binding information for the component's properties.

Parameters:

bindingProperties - The data binding information for the component's properties.

Returns:

Returns a reference to this object so that method calls can be chained together.

children

CreateComponentData.Builder children(Collection<ComponentChild> children)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

children

CreateComponentData.Builder children(ComponentChild... children)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

children

CreateComponentData.Builder children(Consumer<ComponentChild.Builder>... children)

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

This is a convenience method that creates an instance of the ComponentChild.Builder avoiding the need to create one manually via ComponentChild.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #children(List).

Parameters:

children - a consumer that will call methods on ComponentChild.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#children(java.util.Collection)

collectionProperties

CreateComponentData.Builder collectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)

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

Parameters:

collectionProperties - The data binding configuration for customizing a component's properties. Use this for a collection component.

Returns:

Returns a reference to this object so that method calls can be chained together.

componentType

CreateComponentData.Builder componentType(String componentType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

events

CreateComponentData.Builder events(Map<String,ComponentEvent> events)

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

Parameters:

events - 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:

Returns a reference to this object so that method calls can be chained together.

name

CreateComponentData.Builder name(String name)

The name of the component

Parameters:

name - The name of the component

Returns:

Returns a reference to this object so that method calls can be chained together.

overrides

CreateComponentData.Builder overrides(Map<String,? extends Map<String,String>> overrides)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

properties

CreateComponentData.Builder properties(Map<String,ComponentProperty> properties)

Describes the component's properties.

Parameters:

properties - Describes the component's properties.

Returns:

Returns a reference to this object so that method calls can be chained together.

schemaVersion

CreateComponentData.Builder schemaVersion(String schemaVersion)

The schema version of the component when it was imported.

Parameters:

schemaVersion - The schema version of the component when it was imported.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceId

CreateComponentData.Builder sourceId(String sourceId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateComponentData.Builder tags(Map<String,String> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

variants

CreateComponentData.Builder variants(Collection<ComponentVariant> variants)

A list of the unique variants of this component.

Parameters:

variants - A list of the unique variants of this component.

Returns:

Returns a reference to this object so that method calls can be chained together.

variants

CreateComponentData.Builder variants(ComponentVariant... variants)

A list of the unique variants of this component.

Parameters:

variants - A list of the unique variants of this component.

Returns:

Returns a reference to this object so that method calls can be chained together.

variants

CreateComponentData.Builder variants(Consumer<ComponentVariant.Builder>... variants)

A list of the unique variants of this component.

This is a convenience method that creates an instance of the ComponentVariant.Builder avoiding the need to create one manually via ComponentVariant.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #variants(List).

Parameters:

variants - a consumer that will call methods on ComponentVariant.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#variants(java.util.Collection)