1. Packages
  2. AWS Native
  3. API Docs
  4. amplifyuibuilder
  5. getComponent

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

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

aws-native.amplifyuibuilder.getComponent

Explore with Pulumi AI

aws-native logo

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

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

    Definition of AWS::AmplifyUIBuilder::Component Resource Type

    Using getComponent

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getComponent(args: GetComponentArgs, opts?: InvokeOptions): Promise<GetComponentResult>
    function getComponentOutput(args: GetComponentOutputArgs, opts?: InvokeOptions): Output<GetComponentResult>
    def get_component(app_id: Optional[str] = None,
                      environment_name: Optional[str] = None,
                      id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetComponentResult
    def get_component_output(app_id: Optional[pulumi.Input[str]] = None,
                      environment_name: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetComponentResult]
    func LookupComponent(ctx *Context, args *LookupComponentArgs, opts ...InvokeOption) (*LookupComponentResult, error)
    func LookupComponentOutput(ctx *Context, args *LookupComponentOutputArgs, opts ...InvokeOption) LookupComponentResultOutput

    > Note: This function is named LookupComponent in the Go SDK.

    public static class GetComponent 
    {
        public static Task<GetComponentResult> InvokeAsync(GetComponentArgs args, InvokeOptions? opts = null)
        public static Output<GetComponentResult> Invoke(GetComponentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetComponentResult> getComponent(GetComponentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:amplifyuibuilder:getComponent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AppId string
    EnvironmentName string
    Id string
    AppId string
    EnvironmentName string
    Id string
    appId String
    environmentName String
    id String
    appId string
    environmentName string
    id string
    appId String
    environmentName String
    id String

    getComponent Result

    The following output properties are available:

    BindingProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Outputs.ComponentBindingPropertiesValue>
    Children List<Pulumi.AwsNative.AmplifyUiBuilder.Outputs.ComponentChild>
    CollectionProperties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Outputs.ComponentDataConfiguration>
    ComponentType string
    CreatedAt string
    Events Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Outputs.ComponentEvent>
    Id string
    ModifiedAt string
    Name string
    Overrides Dictionary<string, object>
    Properties Dictionary<string, Pulumi.AwsNative.AmplifyUiBuilder.Outputs.ComponentProperty>
    SchemaVersion string
    SourceId string
    Tags Dictionary<string, string>
    Variants List<Pulumi.AwsNative.AmplifyUiBuilder.Outputs.ComponentVariant>
    BindingProperties map[string]ComponentBindingPropertiesValue
    Children []ComponentChild
    CollectionProperties map[string]ComponentDataConfiguration
    ComponentType string
    CreatedAt string
    Events map[string]ComponentEvent
    Id string
    ModifiedAt string
    Name string
    Overrides map[string]interface{}
    Properties map[string]ComponentProperty
    SchemaVersion string
    SourceId string
    Tags map[string]string
    Variants []ComponentVariant
    bindingProperties Map<String,ComponentBindingPropertiesValue>
    children List<ComponentChild>
    collectionProperties Map<String,ComponentDataConfiguration>
    componentType String
    createdAt String
    events Map<String,ComponentEvent>
    id String
    modifiedAt String
    name String
    overrides Map<String,Object>
    properties Map<String,ComponentProperty>
    schemaVersion String
    sourceId String
    tags Map<String,String>
    variants List<ComponentVariant>
    bindingProperties {[key: string]: ComponentBindingPropertiesValue}
    children ComponentChild[]
    collectionProperties {[key: string]: ComponentDataConfiguration}
    componentType string
    createdAt string
    events {[key: string]: ComponentEvent}
    id string
    modifiedAt string
    name string
    overrides {[key: string]: any}
    properties {[key: string]: ComponentProperty}
    schemaVersion string
    sourceId string
    tags {[key: string]: string}
    variants ComponentVariant[]
    binding_properties Mapping[str, ComponentBindingPropertiesValue]
    children Sequence[ComponentChild]
    collection_properties Mapping[str, ComponentDataConfiguration]
    component_type str
    created_at str
    events Mapping[str, ComponentEvent]
    id str
    modified_at str
    name str
    overrides Mapping[str, Any]
    properties Mapping[str, ComponentProperty]
    schema_version str
    source_id str
    tags Mapping[str, str]
    variants Sequence[ComponentVariant]
    bindingProperties Map<Property Map>
    children List<Property Map>
    collectionProperties Map<Property Map>
    componentType String
    createdAt String
    events Map<Property Map>
    id String
    modifiedAt String
    name String
    overrides Map<Any>
    properties Map<Property Map>
    schemaVersion String
    sourceId String
    tags Map<String>
    variants List<Property Map>

    Supporting Types

    ComponentActionParameters

    ComponentBindingPropertiesValue

    ComponentBindingPropertiesValueProperties

    ComponentChild

    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
    ComponentType string
    Name string
    Properties map[string]ComponentProperty
    Children []ComponentChild
    Events map[string]ComponentEvent
    SourceId string
    componentType String
    name String
    properties Map<String,ComponentProperty>
    children List<ComponentChild>
    events Map<String,ComponentEvent>
    sourceId String
    componentType string
    name string
    properties {[key: string]: ComponentProperty}
    children ComponentChild[]
    events {[key: string]: ComponentEvent}
    sourceId string
    component_type str
    name str
    properties Mapping[str, ComponentProperty]
    children Sequence[ComponentChild]
    events Mapping[str, ComponentEvent]
    source_id str
    componentType String
    name String
    properties Map<Property Map>
    children List<Property Map>
    events Map<Property Map>
    sourceId String

    ComponentConditionProperty

    ComponentDataConfiguration

    ComponentEvent

    ComponentFormBindingElement

    Element string
    Property string
    Element string
    Property string
    element String
    property String
    element string
    property string
    element String
    property String

    ComponentMutationActionSetStateParameter

    ComponentPredicate

    ComponentProperty

    ComponentPropertyBindingProperties

    Property string
    Field string
    Property string
    Field string
    property String
    field String
    property string
    field string
    property String
    field String

    ComponentSortDirection

    ComponentSortProperty

    ComponentVariant

    Overrides Dictionary<string, object>
    VariantValues Dictionary<string, string>
    Overrides map[string]interface{}
    VariantValues map[string]string
    overrides Map<String,Object>
    variantValues Map<String,String>
    overrides {[key: string]: any}
    variantValues {[key: string]: string}
    overrides Mapping[str, Any]
    variant_values Mapping[str, str]
    overrides Map<Any>
    variantValues Map<String>

    Package Details

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

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

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