AWS Native v0.103.0, Apr 22 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.amplifyuibuilder.Component

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

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 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 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 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 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 String: The unique name of the resource.
args ComponentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const componentResource = new aws_native.amplifyuibuilder.Component("componentResource", {
    appId: "string",
    bindingProperties: {
        string: {
            bindingProperties: {
                bucket: "string",
                defaultValue: "string",
                field: "string",
                key: "string",
                model: "string",
                predicates: [{
                    and: [componentPredicate],
                    field: "string",
                    operand: "string",
                    operandType: "string",
                    operator: "string",
                    or: [componentPredicate],
                }],
                slotName: "string",
                userAttribute: "string",
            },
            defaultValue: "string",
            type: "string",
        },
    },
    children: [{
        componentType: "string",
        name: "string",
        properties: {
            string: {
                bindingProperties: {
                    property: "string",
                    field: "string",
                },
                bindings: {
                    string: {
                        element: "string",
                        property: "string",
                    },
                },
                collectionBindingProperties: {
                    property: "string",
                    field: "string",
                },
                componentName: "string",
                concat: [componentProperty],
                condition: {
                    "else": componentProperty,
                    field: "string",
                    operand: "string",
                    operandType: "string",
                    operator: "string",
                    property: "string",
                    then: componentProperty,
                },
                configured: false,
                defaultValue: "string",
                event: "string",
                importedValue: "string",
                model: "string",
                property: "string",
                type: "string",
                userAttribute: "string",
                value: "string",
            },
        },
        children: [componentChild],
        events: {
            string: {
                action: "string",
                bindingEvent: "string",
                parameters: {
                    anchor: componentProperty,
                    fields: {
                        string: componentProperty,
                    },
                    global: componentProperty,
                    id: componentProperty,
                    model: "string",
                    state: {
                        componentName: "string",
                        property: "string",
                        set: componentProperty,
                    },
                    target: componentProperty,
                    type: componentProperty,
                    url: componentProperty,
                },
            },
        },
        sourceId: "string",
    }],
    collectionProperties: {
        string: {
            model: "string",
            identifiers: ["string"],
            predicate: componentPredicate,
            sort: [{
                direction: aws_native.amplifyuibuilder.ComponentSortDirection.Asc,
                field: "string",
            }],
        },
    },
    componentType: "string",
    environmentName: "string",
    events: {
        string: {
            action: "string",
            bindingEvent: "string",
            parameters: {
                anchor: componentProperty,
                fields: {
                    string: componentProperty,
                },
                global: componentProperty,
                id: componentProperty,
                model: "string",
                state: {
                    componentName: "string",
                    property: "string",
                    set: componentProperty,
                },
                target: componentProperty,
                type: componentProperty,
                url: componentProperty,
            },
        },
    },
    name: "string",
    overrides: {
        string: "any",
    },
    properties: {
        string: componentProperty,
    },
    schemaVersion: "string",
    sourceId: "string",
    tags: {
        string: "string",
    },
    variants: [{
        overrides: {
            string: "any",
        },
        variantValues: {
            string: "string",
        },
    }],
});

Coming soon!

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

The Component resource accepts the following input properties:

AppId string
BindingProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentBindingPropertiesValueArgs>
Children List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentChild>
CollectionProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentDataConfigurationArgs>
ComponentType string
EnvironmentName string
Events Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentEventArgs>
Name string
Overrides Dictionary<string, object>
Properties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPropertyArgs>
SchemaVersion string
SourceId string
Tags Dictionary<string, string>
Variants List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentVariant>

AppId string
BindingProperties map[string]ComponentBindingPropertiesValueArgs
Children []ComponentChildArgs
CollectionProperties map[string]ComponentDataConfigurationArgs
ComponentType string
EnvironmentName string
Events map[string]ComponentEventArgs
Name string
Overrides map[string]interface{}
Properties map[string]ComponentPropertyArgs
SchemaVersion string
SourceId string
Tags map[string]string
Variants []ComponentVariantArgs

appId String
bindingProperties Map<String,ComponentBindingPropertiesValueArgs>
children List<ComponentChild>
collectionProperties Map<String,ComponentDataConfigurationArgs>
componentType String
environmentName String
events Map<String,ComponentEventArgs>
name String
overrides Map<String,Object>
properties Map<String,ComponentPropertyArgs>
schemaVersion String
sourceId String
tags Map<String,String>
variants List<ComponentVariant>

appId string
bindingProperties {[key: string]: ComponentBindingPropertiesValueArgs}
children ComponentChild[]
collectionProperties {[key: string]: ComponentDataConfigurationArgs}
componentType string
environmentName string
events {[key: string]: ComponentEventArgs}
name string
overrides {[key: string]: any}
properties {[key: string]: ComponentPropertyArgs}
schemaVersion string
sourceId string
tags {[key: string]: string}
variants ComponentVariant[]

app_id str
binding_properties Mapping[str, ComponentBindingPropertiesValueArgs]
children Sequence[ComponentChildArgs]
collection_properties Mapping[str, ComponentDataConfigurationArgs]
component_type str
environment_name str
events Mapping[str, ComponentEventArgs]
name str
overrides Mapping[str, Any]
properties Mapping[str, ComponentPropertyArgs]
schema_version str
source_id str
tags Mapping[str, str]
variants Sequence[ComponentVariantArgs]

appId String
bindingProperties Map<Property Map>
children List<Property Map>
collectionProperties Map<Property Map>
componentType String
environmentName String
events Map<Property Map>
name String
overrides Map<Any>
properties Map<Property Map>
schemaVersion String
sourceId String
tags Map<String>
variants List<Property Map>

Outputs

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

AwsId string
CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
ModifiedAt string

AwsId string
CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
ModifiedAt string

awsId String
createdAt String
id String: The provider-assigned unique ID for this managed resource.
modifiedAt String

awsId string
createdAt string
id string: The provider-assigned unique ID for this managed resource.
modifiedAt string

aws_id str
created_at str
id str: The provider-assigned unique ID for this managed resource.
modified_at str

awsId String
createdAt String
id String: The provider-assigned unique ID for this managed resource.
modifiedAt String

Supporting Types

ComponentActionParameters, ComponentActionParametersArgs

Anchor Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
Fields Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty>
Global Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
Id Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
Model string
State Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentMutationActionSetStateParameter
Target Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
Type Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty
Url Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty

Anchor ComponentProperty
Fields map[string]ComponentProperty
Global ComponentProperty
Id ComponentProperty
Model string
State ComponentMutationActionSetStateParameter
Target ComponentProperty
Type ComponentProperty
Url ComponentProperty

anchor ComponentProperty
fields Map<String,ComponentProperty>
global ComponentProperty
id ComponentProperty
model String
state ComponentMutationActionSetStateParameter
target ComponentProperty
type ComponentProperty
url ComponentProperty

anchor ComponentProperty
fields {[key: string]: ComponentProperty}
global ComponentProperty
id ComponentProperty
model string
state ComponentMutationActionSetStateParameter
target ComponentProperty
type ComponentProperty
url ComponentProperty

anchor ComponentProperty
fields Mapping[str, ComponentProperty]
global_ ComponentProperty
id ComponentProperty
model str
state ComponentMutationActionSetStateParameter
target ComponentProperty
type ComponentProperty
url ComponentProperty

anchor Property Map
fields Map<Property Map>
global Property Map
id Property Map
model String
state Property Map
target Property Map
type Property Map
url Property Map

ComponentBindingPropertiesValue, ComponentBindingPropertiesValueArgs

BindingProperties Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentBindingPropertiesValueProperties
DefaultValue string
Type string

BindingProperties ComponentBindingPropertiesValueProperties
DefaultValue string
Type string

bindingProperties ComponentBindingPropertiesValueProperties
defaultValue String
type String

bindingProperties ComponentBindingPropertiesValueProperties
defaultValue string
type string

binding_properties ComponentBindingPropertiesValueProperties
default_value str
type str

bindingProperties Property Map
defaultValue String
type String

ComponentBindingPropertiesValueProperties, ComponentBindingPropertiesValuePropertiesArgs

Bucket string
DefaultValue string
Field string
Key string
Model string
Predicates List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentPredicate>
SlotName string
UserAttribute string

Bucket string
DefaultValue string
Field string
Key string
Model string
Predicates []ComponentPredicate
SlotName string
UserAttribute string

bucket String
defaultValue String
field String
key String
model String
predicates List<ComponentPredicate>
slotName String
userAttribute String

bucket string
defaultValue string
field string
key string
model string
predicates ComponentPredicate[]
slotName string
userAttribute string

bucket str
default_value str
field str
key str
model str
predicates Sequence[ComponentPredicate]
slot_name str
user_attribute str

bucket String
defaultValue String
field String
key String
model String
predicates List<Property Map>
slotName String
userAttribute String

ComponentChild, ComponentChildArgs

ComponentType string
Name string
Properties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentProperty>
Children List<Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentChild>
Events Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Inputs.ComponentEvent>
SourceId string