software.amazon.awssdk.services.amplifyuibuilder.model

Interface Component.Builder

All Superinterfaces:

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

Enclosing class:

Component

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

Method Summary

Modifier and Type	Method and Description
Component.Builder	appId(String appId) The unique ID of the Amplify app associated with the component.
Component.Builder	bindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties) The information to connect a component's properties to data at runtime.
Component.Builder	children(Collection<ComponentChild> children) A list of the component's ComponentChild instances.
Component.Builder	children(ComponentChild... children) A list of the component's ComponentChild instances.
Component.Builder	children(Consumer<ComponentChild.Builder>... children) A list of the component's ComponentChild instances.
Component.Builder	collectionProperties(Map<String,ComponentDataConfiguration> collectionProperties) The data binding configuration for the component's properties.
Component.Builder	componentType(String componentType) The type of the component.
Component.Builder	createdAt(Instant createdAt) The time that the component was created.
Component.Builder	environmentName(String environmentName) The name of the backend environment that is a part of the Amplify app.
Component.Builder	events(Map<String,ComponentEvent> events) Describes the events that can be raised on the component.
Component.Builder	id(String id) The unique ID of the component.
Component.Builder	modifiedAt(Instant modifiedAt) The time that the component was modified.
Component.Builder	name(String name) The name of the component.
Component.Builder	overrides(Map<String,? extends Map<String,String>> overrides) Describes the component's properties that can be overriden in a customized instance of the component.
Component.Builder	properties(Map<String,ComponentProperty> properties) Describes the component's properties.
Component.Builder	schemaVersion(String schemaVersion) The schema version of the component when it was imported.
Component.Builder	sourceId(String sourceId) The unique ID of the component in its original source system, such as Figma.
Component.Builder	tags(Map<String,String> tags) One or more key-value pairs to use when tagging the component.
Component.Builder	variants(Collection<ComponentVariant> variants) A list of the component's variants.
Component.Builder	variants(ComponentVariant... variants) A list of the component's variants.
Component.Builder	variants(Consumer<ComponentVariant.Builder>... variants) A list of the component's variants.

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

appId

Component.Builder appId(String appId)

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

Parameters:

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

Returns:

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

environmentName

Component.Builder environmentName(String environmentName)

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

Parameters:

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

Returns:

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

sourceId

Component.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.

id

Component.Builder id(String id)

The unique ID of the component.

Parameters:

id - The unique ID of the component.

Returns:

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

name

Component.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.

componentType

Component.Builder componentType(String componentType)

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

Parameters:

componentType - The type of the component. 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.

properties

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

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

Parameters:

properties - Describes the component's properties. You can't specify tags as a valid property for properties.

Returns:

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

children

Component.Builder children(Collection<ComponentChild> children)

A list of the component's ComponentChild instances.

Parameters:

children - A list of the component's ComponentChild instances.

Returns:

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

children

Component.Builder children(ComponentChild... children)

A list of the component's ComponentChild instances.

Parameters:

children - A list of the component's ComponentChild instances.

Returns:

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

children

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

A list of the component's ComponentChild instances.

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)

variants

Component.Builder variants(Collection<ComponentVariant> variants)

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

Parameters:

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

Returns:

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

variants

Component.Builder variants(ComponentVariant... variants)

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

Parameters:

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

Returns:

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

variants

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

A list of the component's variants. A variant is a unique style configuration of a main 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)

overrides

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

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.

Parameters:

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

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

bindingProperties

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

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

Parameters:

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

Returns:

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

collectionProperties

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

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.

Parameters:

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

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

createdAt

Component.Builder createdAt(Instant createdAt)

The time that the component was created.

Parameters:

createdAt - The time that the component was created.

Returns:

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

modifiedAt

Component.Builder modifiedAt(Instant modifiedAt)

The time that the component was modified.

Parameters:

modifiedAt - The time that the component was modified.

Returns:

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

tags

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

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

Parameters:

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

Returns:

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

events

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

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.

Parameters:

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

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

schemaVersion

Component.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.