components

Creates, updates, deletes or gets a component resource or lists components in a region

Overview

Name	components
Type	Resource
Description	Definition of AWS::AmplifyUIBuilder::Component Resource Type
Id	aws.amplifyuibuilder.components

Fields

Name	Datatype	Description
app_id	string
binding_properties	object
children	array
collection_properties	object
component_type	string
created_at	string
environment_name	string
events	object
id	string
modified_at	string
name	string
overrides	object
properties	object
schema_version	string
source_id	string
tags	object
variants	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all components in a region.

SELECT
region,
app_id,
binding_properties,
children,
collection_properties,
component_type,
created_at,
environment_name,
events,
id,
modified_at,
name,
overrides,
properties,
schema_version,
source_id,
tags,
variants
FROM aws.amplifyuibuilder.components
WHERE region = 'us-east-1';

Gets all properties from an individual component.

SELECT
region,
app_id,
binding_properties,
children,
collection_properties,
component_type,
created_at,
environment_name,
events,
id,
modified_at,
name,
overrides,
properties,
schema_version,
source_id,
tags,
variants
FROM aws.amplifyuibuilder.components
WHERE region = 'us-east-1' AND data__Identifier = '<AppId>|<EnvironmentName>|<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new component resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.amplifyuibuilder.components (
 AppId,
 BindingProperties,
 Children,
 CollectionProperties,
 ComponentType,
 EnvironmentName,
 Events,
 Name,
 Overrides,
 Properties,
 SchemaVersion,
 SourceId,
 Tags,
 Variants,
 region
)
SELECT 
'{{ AppId }}',
 '{{ BindingProperties }}',
 '{{ Children }}',
 '{{ CollectionProperties }}',
 '{{ ComponentType }}',
 '{{ EnvironmentName }}',
 '{{ Events }}',
 '{{ Name }}',
 '{{ Overrides }}',
 '{{ Properties }}',
 '{{ SchemaVersion }}',
 '{{ SourceId }}',
 '{{ Tags }}',
 '{{ Variants }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.amplifyuibuilder.components (
 AppId,
 BindingProperties,
 Children,
 CollectionProperties,
 ComponentType,
 EnvironmentName,
 Events,
 Name,
 Overrides,
 Properties,
 SchemaVersion,
 SourceId,
 Tags,
 Variants,
 region
)
SELECT 
 '{{ AppId }}',
 '{{ BindingProperties }}',
 '{{ Children }}',
 '{{ CollectionProperties }}',
 '{{ ComponentType }}',
 '{{ EnvironmentName }}',
 '{{ Events }}',
 '{{ Name }}',
 '{{ Overrides }}',
 '{{ Properties }}',
 '{{ SchemaVersion }}',
 '{{ SourceId }}',
 '{{ Tags }}',
 '{{ Variants }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: component
    props:
      - name: AppId
        value: '{{ AppId }}'
      - name: BindingProperties
        value: {}
      - name: Children
        value:
          - ComponentType: '{{ ComponentType }}'
            Name: '{{ Name }}'
            Properties: {}
            Children:
              - null
            Events: {}
            SourceId: '{{ SourceId }}'
      - name: CollectionProperties
        value: {}
      - name: ComponentType
        value: '{{ ComponentType }}'
      - name: EnvironmentName
        value: '{{ EnvironmentName }}'
      - name: Events
        value: null
      - name: Name
        value: '{{ Name }}'
      - name: Overrides
        value: {}
      - name: Properties
        value: null
      - name: SchemaVersion
        value: '{{ SchemaVersion }}'
      - name: SourceId
        value: '{{ SourceId }}'
      - name: Tags
        value: {}
      - name: Variants
        value:
          - VariantValues: {}
            Overrides: null

DELETE example

/*+ delete */
DELETE FROM aws.amplifyuibuilder.components
WHERE data__Identifier = '<AppId|EnvironmentName|Id>'
AND region = 'us-east-1';

Permissions

To operate on the components resource, the following permissions are required:

Create

amplify:GetApp,
amplifyuibuilder:CreateComponent,
amplifyuibuilder:GetComponent,
amplifyuibuilder:TagResource

Read

amplify:GetApp,
amplifyuibuilder:GetComponent

Update

amplify:GetApp,
amplifyuibuilder:GetComponent,
amplifyuibuilder:TagResource,
amplifyuibuilder:UntagResource,
amplifyuibuilder:UpdateComponent

Delete

amplify:GetApp,
amplifyuibuilder:DeleteComponent,
amplifyuibuilder:GetComponent,
amplifyuibuilder:UntagResource

List

amplify:GetApp,
amplifyuibuilder:ListComponents