Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:10.313Z")
@Stability(Stable)
public interface CfnComponentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnComponent.

Example:

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComponentProps.Builder	A builder for CfnComponentProps
static final class	CfnComponentProps.Jsii$Proxy	An implementation for CfnComponentProps

Method Summary

Modifier and Type	Method	Description
static CfnComponentProps.Builder	builder()
default String	getAppId()	The unique ID of the Amplify app associated with the component.
default Object	getBindingProperties()	The information to connect a component's properties to data at runtime.
default Object	getChildren()	A list of the component's ComponentChild instances.
default Object	getCollectionProperties()	The data binding configuration for the component's properties.
default String	getComponentType()	The type of the component.
default String	getEnvironmentName()	The name of the backend environment that is a part of the Amplify app.
default Object	getEvents()	Describes the events that can be raised on the component.
default String	getName()	The name of the component.
default Object	getOverrides()	Describes the component's properties that can be overriden in a customized instance of the component.
default Object	getProperties()	Describes the component's properties.
default String	getSchemaVersion()	The schema version of the component when it was imported.
default String	getSourceId()	The unique ID of the component in its original source system, such as Figma.
default Map<String,String>	getTags()	One or more key-value pairs to use when tagging the component.
default Object	getVariants()	A list of the component's variants.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppId

@Stability(Stable)
@Nullable
default String getAppId()

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

See Also:

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

getBindingProperties

@Stability(Stable)
@Nullable
default Object getBindingProperties()

The information to connect a component's properties to data at runtime.

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

See Also:

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

getChildren

@Stability(Stable)
@Nullable
default Object getChildren()

A list of the component's ComponentChild instances.

See Also:

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

getCollectionProperties

@Stability(Stable)
@Nullable
default Object getCollectionProperties()

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 .

See Also:

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

getComponentType

@Stability(Stable)
@Nullable
default String getComponentType()

The type of the component.

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

See Also:

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

getEnvironmentName

@Stability(Stable)
@Nullable
default String getEnvironmentName()

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

See Also:

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

getEvents

@Stability(Stable)
@Nullable
default Object getEvents()

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.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the component.

See Also:

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

getOverrides

@Stability(Stable)
@Nullable
default Object getOverrides()

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 .

See Also:

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

getProperties

@Stability(Stable)
@Nullable
default Object getProperties()

Describes the component's properties.

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

See Also:

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

getSchemaVersion

@Stability(Stable)
@Nullable
default String getSchemaVersion()

The schema version of the component when it was imported.

See Also:

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

getSourceId

@Stability(Stable)
@Nullable
default String getSourceId()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

See Also:

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

getVariants

@Stability(Stable)
@Nullable
default Object getVariants()

A list of the component's variants.

A variant is a unique style configuration of a main component.

See Also:

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

builder

@Stability(Stable)
static CfnComponentProps.Builder builder()

Returns:

a CfnComponentProps.Builder of CfnComponentProps