Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. amplifyuibuilder
  5. Component

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.amplifyuibuilder.Component

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::AmplifyUIBuilder::Component Resource Type

Create Component Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Component(name: string, args?: ComponentArgs, opts?: CustomResourceOptions);
@overload
def Component(resource_name: str,
              args: Optional[ComponentArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Component(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              app_id: Optional[str] = None,
              binding_properties: Optional[Mapping[str, ComponentBindingPropertiesValueArgs]] = None,
              children: Optional[Sequence[ComponentChildArgs]] = None,
              collection_properties: Optional[Mapping[str, ComponentDataConfigurationArgs]] = None,
              component_type: Optional[str] = None,
              environment_name: Optional[str] = None,
              events: Optional[Mapping[str, ComponentEventArgs]] = None,
              name: Optional[str] = None,
              overrides: Optional[Mapping[str, Any]] = None,
              properties: Optional[Mapping[str, ComponentPropertyArgs]] = None,
              schema_version: Optional[str] = None,
              source_id: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              variants: Optional[Sequence[ComponentVariantArgs]] = None)
func NewComponent(ctx *Context, name string, args *ComponentArgs, opts ...ResourceOption) (*Component, error)
public Component(string name, ComponentArgs? args = null, CustomResourceOptions? opts = null)
public Component(String name, ComponentArgs args)
public Component(String name, ComponentArgs args, CustomResourceOptions options)

type: aws-native:amplifyuibuilder:Component
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ComponentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Component Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Component resource accepts the following input properties:

AppId string
The unique ID of the Amplify app associated with the component.
BindingProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentBindingPropertiesValueArgs>
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
Children List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentChild>
A list of the component's ComponentChild instances.
CollectionProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentDataConfigurationArgs>
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 .
ComponentType string
The type of the component. This can be an Amplify custom UI component or another custom component.
EnvironmentName string
The name of the backend environment that is a part of the Amplify app.
Events Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentEventArgs>
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.
Name string
The name of the component.
Overrides Dictionary<string, object>
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 .
Properties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPropertyArgs>
Describes the component's properties. You can't specify tags as a valid property for properties .
SchemaVersion string
The schema version of the component when it was imported.
SourceId string
The unique ID of the component in its original source system, such as Figma.
Tags Dictionary<string, string>
One or more key-value pairs to use when tagging the component.
Variants List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentVariant>
A list of the component's variants. A variant is a unique style configuration of a main component.
AppId string
The unique ID of the Amplify app associated with the component.
BindingProperties map[string]ComponentBindingPropertiesValueArgs
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
Children []ComponentChildArgs
A list of the component's ComponentChild instances.
CollectionProperties map[string]ComponentDataConfigurationArgs
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 .
ComponentType string
The type of the component. This can be an Amplify custom UI component or another custom component.
EnvironmentName string
The name of the backend environment that is a part of the Amplify app.
Events map[string]ComponentEventArgs
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.
Name string
The name of the component.
Overrides map[string]interface{}
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 .
Properties map[string]ComponentPropertyArgs
Describes the component's properties. You can't specify tags as a valid property for properties .
SchemaVersion string
The schema version of the component when it was imported.
SourceId string
The unique ID of the component in its original source system, such as Figma.
Tags map[string]string
One or more key-value pairs to use when tagging the component.
Variants []ComponentVariantArgs
A list of the component's variants. A variant is a unique style configuration of a main component.
appId String
The unique ID of the Amplify app associated with the component.
bindingProperties Map<String,ComponentBindingPropertiesValueArgs>
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
children List<ComponentChild>
A list of the component's ComponentChild instances.
collectionProperties Map<String,ComponentDataConfigurationArgs>
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 .
componentType String
The type of the component. This can be an Amplify custom UI component or another custom component.
environmentName String
The name of the backend environment that is a part of the Amplify app.
events Map<String,ComponentEventArgs>
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.
name String
The name of the component.
overrides Map<String,Object>
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 .
properties Map<String,ComponentPropertyArgs>
Describes the component's properties. You can't specify tags as a valid property for properties .
schemaVersion String
The schema version of the component when it was imported.
sourceId String
The unique ID of the component in its original source system, such as Figma.
tags Map<String,String>
One or more key-value pairs to use when tagging the component.
variants List<ComponentVariant>
A list of the component's variants. A variant is a unique style configuration of a main component.
appId string
The unique ID of the Amplify app associated with the component.
bindingProperties {[key: string]: ComponentBindingPropertiesValueArgs}
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
children ComponentChild[]
A list of the component's ComponentChild instances.
collectionProperties {[key: string]: ComponentDataConfigurationArgs}
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 .
componentType string
The type of the component. This can be an Amplify custom UI component or another custom component.
environmentName string
The name of the backend environment that is a part of the Amplify app.
events {[key: string]: ComponentEventArgs}
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.
name string
The name of the component.
overrides {[key: string]: any}
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 .
properties {[key: string]: ComponentPropertyArgs}
Describes the component's properties. You can't specify tags as a valid property for properties .
schemaVersion string
The schema version of the component when it was imported.
sourceId string
The unique ID of the component in its original source system, such as Figma.
tags {[key: string]: string}
One or more key-value pairs to use when tagging the component.
variants ComponentVariant[]
A list of the component's variants. A variant is a unique style configuration of a main component.
app_id str
The unique ID of the Amplify app associated with the component.
binding_properties Mapping[str, ComponentBindingPropertiesValueArgs]
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
children Sequence[ComponentChildArgs]
A list of the component's ComponentChild instances.
collection_properties Mapping[str, ComponentDataConfigurationArgs]
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 .
component_type str
The type of the component. This can be an Amplify custom UI component or another custom component.
environment_name str
The name of the backend environment that is a part of the Amplify app.
events Mapping[str, ComponentEventArgs]
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.
name str
The name of the component.
overrides Mapping[str, Any]
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 .
properties Mapping[str, ComponentPropertyArgs]
Describes the component's properties. You can't specify tags as a valid property for properties .
schema_version str
The schema version of the component when it was imported.
source_id str
The unique ID of the component in its original source system, such as Figma.
tags Mapping[str, str]
One or more key-value pairs to use when tagging the component.
variants Sequence[ComponentVariantArgs]
A list of the component's variants. A variant is a unique style configuration of a main component.
appId String
The unique ID of the Amplify app associated with the component.
bindingProperties Map<Property Map>
The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .
children List<Property Map>
A list of the component's ComponentChild instances.
collectionProperties Map<Property Map>
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 .
componentType String
The type of the component. This can be an Amplify custom UI component or another custom component.
environmentName String
The name of the backend environment that is a part of the Amplify app.
events Map<Property Map>
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.
name String
The name of the component.
overrides Map<Any>
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 .
properties Map<Property Map>
Describes the component's properties. You can't specify tags as a valid property for properties .
schemaVersion String
The schema version of the component when it was imported.
sourceId String
The unique ID of the component in its original source system, such as Figma.
tags Map<String>
One or more key-value pairs to use when tagging the component.
variants List<Property Map>
A list of the component's variants. A variant is a unique style configuration of a main component.

Outputs

All input properties are implicitly available as output properties. Additionally, the Component resource produces the following output properties:

AwsId string
The unique ID of the component.
CreatedAt string
The time that the component was created.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedAt string
The time that the component was modified.
AwsId string
The unique ID of the component.
CreatedAt string
The time that the component was created.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedAt string
The time that the component was modified.
awsId String
The unique ID of the component.
createdAt String
The time that the component was created.
id String
The provider-assigned unique ID for this managed resource.
modifiedAt String
The time that the component was modified.
awsId string
The unique ID of the component.
createdAt string
The time that the component was created.
id string
The provider-assigned unique ID for this managed resource.
modifiedAt string
The time that the component was modified.
aws_id str
The unique ID of the component.
created_at str
The time that the component was created.
id str
The provider-assigned unique ID for this managed resource.
modified_at str
The time that the component was modified.
awsId String
The unique ID of the component.
createdAt String
The time that the component was created.
id String
The provider-assigned unique ID for this managed resource.
modifiedAt String
The time that the component was modified.

Supporting Types

ComponentActionParameters
, ComponentActionParametersArgs

Anchor Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The HTML anchor link to the location to open. Specify this value for a navigation action.
Fields Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty>
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
Global Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
Id Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The unique ID of the component that the ActionParameters apply to.
Model string
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
State Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentMutationActionSetStateParameter
A key-value pair that specifies the state property name and its initial value.
Target Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The element within the same component to modify when the action occurs.
Type Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
Url Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The URL to the location to open. Specify this value for a navigation action.
Anchor ComponentProperty
The HTML anchor link to the location to open. Specify this value for a navigation action.
Fields map[string]ComponentProperty
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
Global ComponentProperty
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
Id ComponentProperty
The unique ID of the component that the ActionParameters apply to.
Model string
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
State ComponentMutationActionSetStateParameter
A key-value pair that specifies the state property name and its initial value.
Target ComponentProperty
The element within the same component to modify when the action occurs.
Type ComponentProperty
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
Url ComponentProperty
The URL to the location to open. Specify this value for a navigation action.
anchor ComponentProperty
The HTML anchor link to the location to open. Specify this value for a navigation action.
fields Map<String,ComponentProperty>
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
global ComponentProperty
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
id ComponentProperty
The unique ID of the component that the ActionParameters apply to.
model String
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state ComponentMutationActionSetStateParameter
A key-value pair that specifies the state property name and its initial value.
target ComponentProperty
The element within the same component to modify when the action occurs.
type ComponentProperty
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
url ComponentProperty
The URL to the location to open. Specify this value for a navigation action.
anchor ComponentProperty
The HTML anchor link to the location to open. Specify this value for a navigation action.
fields {[key: string]: ComponentProperty}
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
global ComponentProperty
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
id ComponentProperty
The unique ID of the component that the ActionParameters apply to.
model string
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state ComponentMutationActionSetStateParameter
A key-value pair that specifies the state property name and its initial value.
target ComponentProperty
The element within the same component to modify when the action occurs.
type ComponentProperty
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
url ComponentProperty
The URL to the location to open. Specify this value for a navigation action.
anchor ComponentProperty
The HTML anchor link to the location to open. Specify this value for a navigation action.
fields Mapping[str, ComponentProperty]
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
global_ ComponentProperty
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
id ComponentProperty
The unique ID of the component that the ActionParameters apply to.
model str
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state ComponentMutationActionSetStateParameter
A key-value pair that specifies the state property name and its initial value.
target ComponentProperty
The element within the same component to modify when the action occurs.
type ComponentProperty
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
url ComponentProperty
The URL to the location to open. Specify this value for a navigation action.
anchor Property Map
The HTML anchor link to the location to open. Specify this value for a navigation action.
fields Map<Property Map>
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
global Property Map
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
id Property Map
The unique ID of the component that the ActionParameters apply to.
model String
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state Property Map
A key-value pair that specifies the state property name and its initial value.
target Property Map
The element within the same component to modify when the action occurs.
type Property Map
The type of navigation action. Valid values are url and anchor . This value is required for a navigation action.
url Property Map
The URL to the location to open. Specify this value for a navigation action.

ComponentBindingPropertiesValue
, ComponentBindingPropertiesValueArgs

BindingProperties Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
DefaultValue string
The default value of the property.
Type string
The property type.
BindingProperties ComponentBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
DefaultValue string
The default value of the property.
Type string
The property type.
bindingProperties ComponentBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
defaultValue String
The default value of the property.
type String
The property type.
bindingProperties ComponentBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
defaultValue string
The default value of the property.
type string
The property type.
binding_properties ComponentBindingPropertiesValueProperties
Describes the properties to customize with data at runtime.
default_value str
The default value of the property.
type str
The property type.
bindingProperties Property Map
Describes the properties to customize with data at runtime.
defaultValue String
The default value of the property.
type String
The property type.

ComponentBindingPropertiesValueProperties
, ComponentBindingPropertiesValuePropertiesArgs

Bucket string
An Amazon S3 bucket.
DefaultValue string
The default value to assign to the property.
Field string
The field to bind the data to.
Key string
The storage key for an Amazon S3 bucket.
Model string
An Amplify DataStore model.
Predicates List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPredicate>
A list of predicates for binding a component's properties to data.
SlotName string
The name of a component slot.
UserAttribute string
An authenticated user attribute.
Bucket string
An Amazon S3 bucket.
DefaultValue string
The default value to assign to the property.
Field string
The field to bind the data to.
Key string
The storage key for an Amazon S3 bucket.
Model string
An Amplify DataStore model.
Predicates []ComponentPredicate
A list of predicates for binding a component's properties to data.
SlotName string
The name of a component slot.
UserAttribute string
An authenticated user attribute.
bucket String
An Amazon S3 bucket.
defaultValue String
The default value to assign to the property.
field String
The field to bind the data to.
key String
The storage key for an Amazon S3 bucket.
model String
An Amplify DataStore model.
predicates List<ComponentPredicate>
A list of predicates for binding a component's properties to data.
slotName String
The name of a component slot.
userAttribute String
An authenticated user attribute.
bucket string
An Amazon S3 bucket.
defaultValue string
The default value to assign to the property.
field string
The field to bind the data to.
key string
The storage key for an Amazon S3 bucket.
model string
An Amplify DataStore model.
predicates ComponentPredicate[]
A list of predicates for binding a component's properties to data.
slotName string
The name of a component slot.
userAttribute string
An authenticated user attribute.
bucket str
An Amazon S3 bucket.
default_value str
The default value to assign to the property.
field str
The field to bind the data to.
key str
The storage key for an Amazon S3 bucket.
model str
An Amplify DataStore model.
predicates Sequence[ComponentPredicate]
A list of predicates for binding a component's properties to data.
slot_name str
The name of a component slot.
user_attribute str
An authenticated user attribute.
bucket String
An Amazon S3 bucket.
defaultValue String
The default value to assign to the property.
field String
The field to bind the data to.
key String
The storage key for an Amazon S3 bucket.
model String
An Amplify DataStore model.
predicates List<Property Map>
A list of predicates for binding a component's properties to data.
slotName String
The name of a component slot.
userAttribute String
An authenticated user attribute.

ComponentChild
, ComponentChildArgs

ComponentType This property is required. string
The type of the child component.
Name This property is required. string
The name of the child component.
Properties This property is required. Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty>
Describes the properties of the child component. You can't specify tags as a valid property for properties .
Children List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentChild>
The list of ComponentChild instances for this component.
Events Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentEvent>
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
SourceId string
The unique ID of the child component in its original source system, such as Figma.
ComponentType This property is required. string
The type of the child component.
Name This property is required. string
The name of the child component.
Properties This property is required. map[string]ComponentProperty
Describes the properties of the child component. You can't specify tags as a valid property for properties .
Children []ComponentChild
The list of ComponentChild instances for this component.
Events map[string]ComponentEvent
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
SourceId string
The unique ID of the child component in its original source system, such as Figma.
componentType This property is required. String
The type of the child component.
name This property is required. String
The name of the child component.
properties This property is required. Map<String,ComponentProperty>
Describes the properties of the child component. You can't specify tags as a valid property for properties .
children List<ComponentChild>
The list of ComponentChild instances for this component.
events Map<String,ComponentEvent>
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
sourceId String
The unique ID of the child component in its original source system, such as Figma.
componentType This property is required. string
The type of the child component.
name This property is required. string
The name of the child component.
properties This property is required. {[key: string]: ComponentProperty}
Describes the properties of the child component. You can't specify tags as a valid property for properties .
children ComponentChild[]
The list of ComponentChild instances for this component.
events {[key: string]: ComponentEvent}
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
sourceId string
The unique ID of the child component in its original source system, such as Figma.
component_type This property is required. str
The type of the child component.
name This property is required. str
The name of the child component.
properties This property is required. Mapping[str, ComponentProperty]
Describes the properties of the child component. You can't specify tags as a valid property for properties .
children Sequence[ComponentChild]
The list of ComponentChild instances for this component.
events Mapping[str, ComponentEvent]
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
source_id str
The unique ID of the child component in its original source system, such as Figma.
componentType This property is required. String
The type of the child component.
name This property is required. String
The name of the child component.
properties This property is required. Map<Property Map>
Describes the properties of the child component. You can't specify tags as a valid property for properties .
children List<Property Map>
The list of ComponentChild instances for this component.
events Map<Property Map>
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
sourceId String
The unique ID of the child component in its original source system, such as Figma.

ComponentConditionProperty
, ComponentConditionPropertyArgs

Else Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The value to assign to the property if the condition is not met.
Field string
The name of a field. Specify this when the property is a data model.
Operand string
The value of the property to evaluate.
OperandType string
The type of the property to evaluate.
Operator string
The operator to use to perform the evaluation, such as eq to represent equals.
Property string
The name of the conditional property.
Then Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The value to assign to the property if the condition is met.
Else ComponentProperty
The value to assign to the property if the condition is not met.
Field string
The name of a field. Specify this when the property is a data model.
Operand string
The value of the property to evaluate.
OperandType string
The type of the property to evaluate.
Operator string
The operator to use to perform the evaluation, such as eq to represent equals.
Property string
The name of the conditional property.
Then ComponentProperty
The value to assign to the property if the condition is met.
else_ ComponentProperty
The value to assign to the property if the condition is not met.
field String
The name of a field. Specify this when the property is a data model.
operand String
The value of the property to evaluate.
operandType String
The type of the property to evaluate.
operator String
The operator to use to perform the evaluation, such as eq to represent equals.
property String
The name of the conditional property.
then ComponentProperty
The value to assign to the property if the condition is met.
else ComponentProperty
The value to assign to the property if the condition is not met.
field string
The name of a field. Specify this when the property is a data model.
operand string
The value of the property to evaluate.
operandType string
The type of the property to evaluate.
operator string
The operator to use to perform the evaluation, such as eq to represent equals.
property string
The name of the conditional property.
then ComponentProperty
The value to assign to the property if the condition is met.
else_ ComponentProperty
The value to assign to the property if the condition is not met.
field str
The name of a field. Specify this when the property is a data model.
operand str
The value of the property to evaluate.
operand_type str
The type of the property to evaluate.
operator str
The operator to use to perform the evaluation, such as eq to represent equals.
property str
The name of the conditional property.
then ComponentProperty
The value to assign to the property if the condition is met.
else Property Map
The value to assign to the property if the condition is not met.
field String
The name of a field. Specify this when the property is a data model.
operand String
The value of the property to evaluate.
operandType String
The type of the property to evaluate.
operator String
The operator to use to perform the evaluation, such as eq to represent equals.
property String
The name of the conditional property.
then Property Map
The value to assign to the property if the condition is met.

ComponentDataConfiguration
, ComponentDataConfigurationArgs

Model This property is required. string
The name of the data model to use to bind data to a component.
Identifiers List<string>
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
Predicate Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPredicate
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
Sort List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentSortProperty>
Describes how to sort the component's properties.
Model This property is required. string
The name of the data model to use to bind data to a component.
Identifiers []string
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
Predicate ComponentPredicate
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
Sort []ComponentSortProperty
Describes how to sort the component's properties.
model This property is required. String
The name of the data model to use to bind data to a component.
identifiers List<String>
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
predicate ComponentPredicate
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
sort List<ComponentSortProperty>
Describes how to sort the component's properties.
model This property is required. string
The name of the data model to use to bind data to a component.
identifiers string[]
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
predicate ComponentPredicate
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
sort ComponentSortProperty[]
Describes how to sort the component's properties.
model This property is required. str
The name of the data model to use to bind data to a component.
identifiers Sequence[str]
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
predicate ComponentPredicate
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
sort Sequence[ComponentSortProperty]
Describes how to sort the component's properties.
model This property is required. String
The name of the data model to use to bind data to a component.
identifiers List<String>
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
predicate Property Map
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
sort List<Property Map>
Describes how to sort the component's properties.

ComponentEvent
, ComponentEventArgs

Action string
The action to perform when a specific event is raised.
BindingEvent string
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
Parameters Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentActionParameters
Describes information about the action.
Action string
The action to perform when a specific event is raised.
BindingEvent string
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
Parameters ComponentActionParameters
Describes information about the action.
action String
The action to perform when a specific event is raised.
bindingEvent String
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters ComponentActionParameters
Describes information about the action.
action string
The action to perform when a specific event is raised.
bindingEvent string
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters ComponentActionParameters
Describes information about the action.
action str
The action to perform when a specific event is raised.
binding_event str
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters ComponentActionParameters
Describes information about the action.
action String
The action to perform when a specific event is raised.
bindingEvent String
Binds an event to an action on a component. When you specify a bindingEvent , the event is called when the action is performed.
parameters Property Map
Describes information about the action.

ComponentFormBindingElement
, ComponentFormBindingElementArgs

Element This property is required. string
The name of the component to retrieve a value from.
Property This property is required. string
The property to retrieve a value from.
Element This property is required. string
The name of the component to retrieve a value from.
Property This property is required. string
The property to retrieve a value from.
element This property is required. String
The name of the component to retrieve a value from.
property This property is required. String
The property to retrieve a value from.
element This property is required. string
The name of the component to retrieve a value from.
property This property is required. string
The property to retrieve a value from.
element This property is required. str
The name of the component to retrieve a value from.
property This property is required. str
The property to retrieve a value from.
element This property is required. String
The name of the component to retrieve a value from.
property This property is required. String
The property to retrieve a value from.

ComponentMutationActionSetStateParameter
, ComponentMutationActionSetStateParameterArgs

ComponentName This property is required. string
The name of the component that is being modified.
Property This property is required. string
The name of the component property to apply the state configuration to.
Set This property is required. Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
The state configuration to assign to the property.
ComponentName This property is required. string
The name of the component that is being modified.
Property This property is required. string
The name of the component property to apply the state configuration to.
Set This property is required. ComponentProperty
The state configuration to assign to the property.
componentName This property is required. String
The name of the component that is being modified.
property This property is required. String
The name of the component property to apply the state configuration to.
set This property is required. ComponentProperty
The state configuration to assign to the property.
componentName This property is required. string
The name of the component that is being modified.
property This property is required. string
The name of the component property to apply the state configuration to.
set This property is required. ComponentProperty
The state configuration to assign to the property.
component_name This property is required. str
The name of the component that is being modified.
property This property is required. str
The name of the component property to apply the state configuration to.
set This property is required. ComponentProperty
The state configuration to assign to the property.
componentName This property is required. String
The name of the component that is being modified.
property This property is required. String
The name of the component property to apply the state configuration to.
set This property is required. Property Map
The state configuration to assign to the property.

ComponentPredicate
, ComponentPredicateArgs

And List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPredicate>
A list of predicates to combine logically.
Field string
The field to query.
Operand string
The value to use when performing the evaluation.
OperandType string
The type of value to use when performing the evaluation.
Operator string
The operator to use to perform the evaluation.
Or List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPredicate>
A list of predicates to combine logically.
And []ComponentPredicate
A list of predicates to combine logically.
Field string
The field to query.
Operand string
The value to use when performing the evaluation.
OperandType string
The type of value to use when performing the evaluation.
Operator string
The operator to use to perform the evaluation.
Or []ComponentPredicate
A list of predicates to combine logically.
and List<ComponentPredicate>
A list of predicates to combine logically.
field String
The field to query.
operand String
The value to use when performing the evaluation.
operandType String
The type of value to use when performing the evaluation.
operator String
The operator to use to perform the evaluation.
or List<ComponentPredicate>
A list of predicates to combine logically.
and ComponentPredicate[]
A list of predicates to combine logically.
field string
The field to query.
operand string
The value to use when performing the evaluation.
operandType string
The type of value to use when performing the evaluation.
operator string
The operator to use to perform the evaluation.
or ComponentPredicate[]
A list of predicates to combine logically.
and_ Sequence[ComponentPredicate]
A list of predicates to combine logically.
field str
The field to query.
operand str
The value to use when performing the evaluation.
operand_type str
The type of value to use when performing the evaluation.
operator str
The operator to use to perform the evaluation.
or_ Sequence[ComponentPredicate]
A list of predicates to combine logically.
and List<Property Map>
A list of predicates to combine logically.
field String
The field to query.
operand String
The value to use when performing the evaluation.
operandType String
The type of value to use when performing the evaluation.
operator String
The operator to use to perform the evaluation.
or List<Property Map>
A list of predicates to combine logically.

ComponentProperty
, ComponentPropertyArgs

BindingProperties Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPropertyBindingProperties
The information to bind the component property to data at runtime.
Bindings Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentFormBindingElement>
The information to bind the component property to form data.
CollectionBindingProperties Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPropertyBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
ComponentName string
The name of the component that is affected by an event.
Concat List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty>
A list of component properties to concatenate to create the value to assign to this component property.
Condition Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentConditionProperty
The conditional expression to use to assign a value to the component property.
Configured bool
Specifies whether the user configured the property in Amplify Studio after importing it.
DefaultValue string
The default value to assign to the component property.
Event string
An event that occurs in your app. Use this for workflow data binding.
ImportedValue string
The default value assigned to the property when the component is imported into an app.
Model string
The data model to use to assign a value to the component property.
Property string
The name of the component's property that is affected by an event.
Type string
The component type.
UserAttribute string
An authenticated user attribute to use to assign a value to the component property.
Value string
The value to assign to the component property.
BindingProperties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime.
Bindings map[string]ComponentFormBindingElement
The information to bind the component property to form data.
CollectionBindingProperties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
ComponentName string
The name of the component that is affected by an event.
Concat []ComponentProperty
A list of component properties to concatenate to create the value to assign to this component property.
Condition ComponentConditionProperty
The conditional expression to use to assign a value to the component property.
Configured bool
Specifies whether the user configured the property in Amplify Studio after importing it.
DefaultValue string
The default value to assign to the component property.
Event string
An event that occurs in your app. Use this for workflow data binding.
ImportedValue string
The default value assigned to the property when the component is imported into an app.
Model string
The data model to use to assign a value to the component property.
Property string
The name of the component's property that is affected by an event.
Type string
The component type.
UserAttribute string
An authenticated user attribute to use to assign a value to the component property.
Value string
The value to assign to the component property.
bindingProperties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime.
bindings Map<String,ComponentFormBindingElement>
The information to bind the component property to form data.
collectionBindingProperties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
componentName String
The name of the component that is affected by an event.
concat List<ComponentProperty>
A list of component properties to concatenate to create the value to assign to this component property.
condition ComponentConditionProperty
The conditional expression to use to assign a value to the component property.
configured Boolean
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue String
The default value to assign to the component property.
event String
An event that occurs in your app. Use this for workflow data binding.
importedValue String
The default value assigned to the property when the component is imported into an app.
model String
The data model to use to assign a value to the component property.
property String
The name of the component's property that is affected by an event.
type String
The component type.
userAttribute String
An authenticated user attribute to use to assign a value to the component property.
value String
The value to assign to the component property.
bindingProperties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime.
bindings {[key: string]: ComponentFormBindingElement}
The information to bind the component property to form data.
collectionBindingProperties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
componentName string
The name of the component that is affected by an event.
concat ComponentProperty[]
A list of component properties to concatenate to create the value to assign to this component property.
condition ComponentConditionProperty
The conditional expression to use to assign a value to the component property.
configured boolean
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue string
The default value to assign to the component property.
event string
An event that occurs in your app. Use this for workflow data binding.
importedValue string
The default value assigned to the property when the component is imported into an app.
model string
The data model to use to assign a value to the component property.
property string
The name of the component's property that is affected by an event.
type string
The component type.
userAttribute string
An authenticated user attribute to use to assign a value to the component property.
value string
The value to assign to the component property.
binding_properties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime.
bindings Mapping[str, ComponentFormBindingElement]
The information to bind the component property to form data.
collection_binding_properties ComponentPropertyBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
component_name str
The name of the component that is affected by an event.
concat Sequence[ComponentProperty]
A list of component properties to concatenate to create the value to assign to this component property.
condition ComponentConditionProperty
The conditional expression to use to assign a value to the component property.
configured bool
Specifies whether the user configured the property in Amplify Studio after importing it.
default_value str
The default value to assign to the component property.
event str
An event that occurs in your app. Use this for workflow data binding.
imported_value str
The default value assigned to the property when the component is imported into an app.
model str
The data model to use to assign a value to the component property.
property str
The name of the component's property that is affected by an event.
type str
The component type.
user_attribute str
An authenticated user attribute to use to assign a value to the component property.
value str
The value to assign to the component property.
bindingProperties Property Map
The information to bind the component property to data at runtime.
bindings Map<Property Map>
The information to bind the component property to form data.
collectionBindingProperties Property Map
The information to bind the component property to data at runtime. Use this for collection components.
componentName String
The name of the component that is affected by an event.
concat List<Property Map>
A list of component properties to concatenate to create the value to assign to this component property.
condition Property Map
The conditional expression to use to assign a value to the component property.
configured Boolean
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue String
The default value to assign to the component property.
event String
An event that occurs in your app. Use this for workflow data binding.
importedValue String
The default value assigned to the property when the component is imported into an app.
model String
The data model to use to assign a value to the component property.
property String
The name of the component's property that is affected by an event.
type String
The component type.
userAttribute String
An authenticated user attribute to use to assign a value to the component property.
value String
The value to assign to the component property.

ComponentPropertyBindingProperties
, ComponentPropertyBindingPropertiesArgs

Property This property is required. string
The component property to bind to the data field.
Field string
The data field to bind the property to.
Property This property is required. string
The component property to bind to the data field.
Field string
The data field to bind the property to.
property This property is required. String
The component property to bind to the data field.
field String
The data field to bind the property to.
property This property is required. string
The component property to bind to the data field.
field string
The data field to bind the property to.
property This property is required. str
The component property to bind to the data field.
field str
The data field to bind the property to.
property This property is required. String
The component property to bind to the data field.
field String
The data field to bind the property to.

ComponentSortDirection
, ComponentSortDirectionArgs

Asc
ASC
Desc
DESC
ComponentSortDirectionAsc
ASC
ComponentSortDirectionDesc
DESC
Asc
ASC
Desc
DESC
Asc
ASC
Desc
DESC
ASC
ASC
DESC
DESC
"ASC"
ASC
"DESC"
DESC

ComponentSortProperty
, ComponentSortPropertyArgs

Direction This property is required. Pulumi.AwsNative.AmplifyUiBuilder.ComponentSortDirection
The direction of the sort, either ascending or descending.
Field This property is required. string
The field to perform the sort on.
Direction This property is required. ComponentSortDirection
The direction of the sort, either ascending or descending.
Field This property is required. string
The field to perform the sort on.
direction This property is required. ComponentSortDirection
The direction of the sort, either ascending or descending.
field This property is required. String
The field to perform the sort on.
direction This property is required. ComponentSortDirection
The direction of the sort, either ascending or descending.
field This property is required. string
The field to perform the sort on.
direction This property is required. ComponentSortDirection
The direction of the sort, either ascending or descending.
field This property is required. str
The field to perform the sort on.
direction This property is required. "ASC" | "DESC"
The direction of the sort, either ascending or descending.
field This property is required. String
The field to perform the sort on.

ComponentVariant
, ComponentVariantArgs

Overrides Dictionary<string, object>
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
VariantValues Dictionary<string, string>
The combination of variants that comprise this variant.
Overrides map[string]interface{}
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
VariantValues map[string]string
The combination of variants that comprise this variant.
overrides Map<String,Object>
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
variantValues Map<String,String>
The combination of variants that comprise this variant.
overrides {[key: string]: any}
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
variantValues {[key: string]: string}
The combination of variants that comprise this variant.
overrides Mapping[str, Any]
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
variant_values Mapping[str, str]
The combination of variants that comprise this variant.
overrides Map<Any>
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides .
variantValues Map<String>
The combination of variants that comprise this variant.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native