software.amazon.awscdk.services.amplifyuibuilder

Class CfnComponentProps.Builder

java.lang.Object

software.amazon.awscdk.services.amplifyuibuilder.CfnComponentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComponentProps>

Enclosing interface:

CfnComponentProps

@Stability(value=Stable)
public static final class CfnComponentProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnComponentProps>

A builder for CfnComponentProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnComponentProps.Builder	bindingProperties(IResolvable bindingProperties) Sets the value of CfnComponentProps.getBindingProperties()
CfnComponentProps.Builder	bindingProperties(Map<String,? extends Object> bindingProperties) Sets the value of CfnComponentProps.getBindingProperties()
CfnComponentProps	build() Builds the configured instance.
CfnComponentProps.Builder	children(IResolvable children) Sets the value of CfnComponentProps.getChildren()
CfnComponentProps.Builder	children(List<? extends Object> children) Sets the value of CfnComponentProps.getChildren()
CfnComponentProps.Builder	collectionProperties(IResolvable collectionProperties) Sets the value of CfnComponentProps.getCollectionProperties()
CfnComponentProps.Builder	collectionProperties(Map<String,? extends Object> collectionProperties) Sets the value of CfnComponentProps.getCollectionProperties()
CfnComponentProps.Builder	componentType(String componentType) Sets the value of CfnComponentProps.getComponentType()
CfnComponentProps.Builder	events(IResolvable events) Sets the value of CfnComponentProps.getEvents()
CfnComponentProps.Builder	events(Map<String,? extends Object> events) Sets the value of CfnComponentProps.getEvents()
CfnComponentProps.Builder	name(String name) Sets the value of CfnComponentProps.getName()
CfnComponentProps.Builder	overrides(IResolvable overrides) Sets the value of CfnComponentProps.getOverrides()
CfnComponentProps.Builder	overrides(Map<String,? extends Object> overrides) Sets the value of CfnComponentProps.getOverrides()
CfnComponentProps.Builder	properties(IResolvable properties) Sets the value of CfnComponentProps.getProperties()
CfnComponentProps.Builder	properties(Map<String,? extends Object> properties) Sets the value of CfnComponentProps.getProperties()
CfnComponentProps.Builder	schemaVersion(String schemaVersion) Sets the value of CfnComponentProps.getSchemaVersion()
CfnComponentProps.Builder	sourceId(String sourceId) Sets the value of CfnComponentProps.getSourceId()
CfnComponentProps.Builder	tags(Map<String,String> tags) Sets the value of CfnComponentProps.getTags()
CfnComponentProps.Builder	variants(IResolvable variants) Sets the value of CfnComponentProps.getVariants()
CfnComponentProps.Builder	variants(List<? extends Object> variants) Sets the value of CfnComponentProps.getVariants()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

bindingProperties

@Stability(value=Stable)
public CfnComponentProps.Builder bindingProperties(IResolvable bindingProperties)

Sets the value of CfnComponentProps.getBindingProperties()

Parameters:

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

Returns:

this

bindingProperties

@Stability(value=Stable)
public CfnComponentProps.Builder bindingProperties(Map<String,? extends Object> bindingProperties)

Sets the value of CfnComponentProps.getBindingProperties()

Parameters:

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

Returns:

this

componentType

@Stability(value=Stable)
public CfnComponentProps.Builder componentType(String componentType)

Sets the value of CfnComponentProps.getComponentType()

Parameters:

componentType - The type of the component. This parameter is required. This can be an Amplify custom UI component or another custom component.

Returns:

this

name

@Stability(value=Stable)
public CfnComponentProps.Builder name(String name)

Sets the value of CfnComponentProps.getName()

Parameters:

name - The name of the component. This parameter is required.

Returns:

this

overrides

@Stability(value=Stable)
public CfnComponentProps.Builder overrides(IResolvable overrides)

Sets the value of CfnComponentProps.getOverrides()

Parameters:

overrides - Describes the component's properties that can be overriden in a customized instance of the component. This parameter is required. You can't specify tags as a valid property for overrides .

Returns:

this

overrides

@Stability(value=Stable)
public CfnComponentProps.Builder overrides(Map<String,? extends Object> overrides)

Sets the value of CfnComponentProps.getOverrides()

Parameters:

overrides - Describes the component's properties that can be overriden in a customized instance of the component. This parameter is required. You can't specify tags as a valid property for overrides .

Returns:

this

properties

@Stability(value=Stable)
public CfnComponentProps.Builder properties(IResolvable properties)

Sets the value of CfnComponentProps.getProperties()

Parameters:

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

Returns:

this

properties

@Stability(value=Stable)
public CfnComponentProps.Builder properties(Map<String,? extends Object> properties)

Sets the value of CfnComponentProps.getProperties()

Parameters:

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

Returns:

this

variants

@Stability(value=Stable)
public CfnComponentProps.Builder variants(IResolvable variants)

Sets the value of CfnComponentProps.getVariants()

Parameters:

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

Returns:

this

variants

@Stability(value=Stable)
public CfnComponentProps.Builder variants(List<? extends Object> variants)

Sets the value of CfnComponentProps.getVariants()

Parameters:

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

Returns:

this

children

@Stability(value=Stable)
public CfnComponentProps.Builder children(IResolvable children)

Sets the value of CfnComponentProps.getChildren()

Parameters:

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

Returns:

this

children

@Stability(value=Stable)
public CfnComponentProps.Builder children(List<? extends Object> children)

Sets the value of CfnComponentProps.getChildren()

Parameters:

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

Returns:

this

collectionProperties

@Stability(value=Stable)
public CfnComponentProps.Builder collectionProperties(IResolvable collectionProperties)

Sets the value of CfnComponentProps.getCollectionProperties()

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:

this

collectionProperties

@Stability(value=Stable)
public CfnComponentProps.Builder collectionProperties(Map<String,? extends Object> collectionProperties)

Sets the value of CfnComponentProps.getCollectionProperties()

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:

this

events

@Stability(value=Stable)
public CfnComponentProps.Builder events(IResolvable events)

Sets the value of CfnComponentProps.getEvents()

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:

this

events

@Stability(value=Stable)
public CfnComponentProps.Builder events(Map<String,? extends Object> events)

Sets the value of CfnComponentProps.getEvents()

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:

this

schemaVersion

@Stability(value=Stable)
public CfnComponentProps.Builder schemaVersion(String schemaVersion)

Sets the value of CfnComponentProps.getSchemaVersion()

Parameters:

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

Returns:

this

sourceId

@Stability(value=Stable)
public CfnComponentProps.Builder sourceId(String sourceId)

Sets the value of CfnComponentProps.getSourceId()

Parameters:

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

Returns:

this

tags

@Stability(value=Stable)
public CfnComponentProps.Builder tags(Map<String,String> tags)

Sets the value of CfnComponentProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public CfnComponentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnComponentProps>

Returns:

a new instance of CfnComponentProps

Throws:

NullPointerException - if any required attribute was not provided