Package software.amazon.awscdk.mixins.preview.services.amplifyuibuilder.mixins

Class CfnComponentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.amplifyuibuilder.mixins.CfnComponentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComponentPropsMixin>

Enclosing class:

CfnComponentPropsMixin

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

A fluent builder for CfnComponentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnComponentPropsMixin.Builder	appId(String appId)	The unique ID of the Amplify app associated with the component.
CfnComponentPropsMixin.Builder	bindingProperties(Map<String,? extends Object> bindingProperties)	The information to connect a component's properties to data at runtime.
CfnComponentPropsMixin.Builder	bindingProperties(IResolvable bindingProperties)	The information to connect a component's properties to data at runtime.
CfnComponentPropsMixin	build()
CfnComponentPropsMixin.Builder	children(List<? extends Object> children)	A list of the component's ComponentChild instances.
CfnComponentPropsMixin.Builder	children(IResolvable children)	A list of the component's ComponentChild instances.
CfnComponentPropsMixin.Builder	collectionProperties(Map<String,? extends Object> collectionProperties)	The data binding configuration for the component's properties.
CfnComponentPropsMixin.Builder	collectionProperties(IResolvable collectionProperties)	The data binding configuration for the component's properties.
CfnComponentPropsMixin.Builder	componentType(String componentType)	The type of the component.
static CfnComponentPropsMixin.Builder	create()
static CfnComponentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnComponentPropsMixin.Builder	environmentName(String environmentName)	The name of the backend environment that is a part of the Amplify app.
CfnComponentPropsMixin.Builder	events(Map<String,? extends Object> events)	Describes the events that can be raised on the component.
CfnComponentPropsMixin.Builder	events(IResolvable events)	Describes the events that can be raised on the component.
CfnComponentPropsMixin.Builder	name(String name)	The name of the component.
CfnComponentPropsMixin.Builder	overrides(Object overrides)	Describes the component's properties that can be overriden in a customized instance of the component.
CfnComponentPropsMixin.Builder	properties(Map<String,? extends Object> properties)	Describes the component's properties.
CfnComponentPropsMixin.Builder	properties(IResolvable properties)	Describes the component's properties.
CfnComponentPropsMixin.Builder	schemaVersion(String schemaVersion)	The schema version of the component when it was imported.
CfnComponentPropsMixin.Builder	sourceId(String sourceId)	The unique ID of the component in its original source system, such as Figma.
CfnComponentPropsMixin.Builder	tags(Map<String,String> tags)	One or more key-value pairs to use when tagging the component.
CfnComponentPropsMixin.Builder	variants(List<? extends Object> variants)	A list of the component's variants.
CfnComponentPropsMixin.Builder	variants(IResolvable variants)	A list of the component's variants.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnComponentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnComponentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnComponentPropsMixin.Builder create()

Returns:

a new instance of CfnComponentPropsMixin.Builder.

appId

@Stability(Stable)
public CfnComponentPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-appid

bindingProperties

@Stability(Stable)
public CfnComponentPropsMixin.Builder bindingProperties(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-bindingproperties

bindingProperties

@Stability(Stable)
public CfnComponentPropsMixin.Builder bindingProperties(Map<String,? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-bindingproperties

children

@Stability(Stable)
public CfnComponentPropsMixin.Builder children(IResolvable children)

A list of the component's ComponentChild instances.

Parameters:

children - A list of the component's ComponentChild instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-children

children

@Stability(Stable)
public CfnComponentPropsMixin.Builder children(List<? extends Object> children)

A list of the component's ComponentChild instances.

Parameters:

children - A list of the component's ComponentChild instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-children

collectionProperties

@Stability(Stable)
public CfnComponentPropsMixin.Builder collectionProperties(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-collectionproperties

collectionProperties

@Stability(Stable)
public CfnComponentPropsMixin.Builder collectionProperties(Map<String,? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-collectionproperties

componentType

@Stability(Stable)
public CfnComponentPropsMixin.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 parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-componenttype

environmentName

@Stability(Stable)
public CfnComponentPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-environmentname

events

@Stability(Stable)
public CfnComponentPropsMixin.Builder events(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-events

events

@Stability(Stable)
public CfnComponentPropsMixin.Builder events(Map<String,? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-events

name

@Stability(Stable)
public CfnComponentPropsMixin.Builder name(String name)

The name of the component.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-name

overrides

@Stability(Stable)
public CfnComponentPropsMixin.Builder overrides(Object 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-overrides

properties

@Stability(Stable)
public CfnComponentPropsMixin.Builder properties(IResolvable properties)

Describes the component's properties.

You can't specify tags as a valid property for properties .

Parameters:

properties - Describes the component's properties. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-properties

properties

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

Describes the component's properties.

You can't specify tags as a valid property for properties .

Parameters:

properties - Describes the component's properties. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-properties

schemaVersion

@Stability(Stable)
public CfnComponentPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-schemaversion

sourceId

@Stability(Stable)
public CfnComponentPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-sourceid

tags

@Stability(Stable)
public CfnComponentPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-tags

variants

@Stability(Stable)
public CfnComponentPropsMixin.Builder variants(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-variants

variants

@Stability(Stable)
public CfnComponentPropsMixin.Builder variants(List<? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-variants

build

@Stability(Stable)
public CfnComponentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnComponentPropsMixin.