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	awscc.amplifyuibuilder.components

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
app_id	string
environment_name	string
id	string
name	string
region	string	AWS region.

For more information, see AWS::AmplifyUIBuilder::Component.

Methods

Name	Resource	Accessible by	Required Params
create_resource	components	INSERT	region
delete_resource	components	DELETE	Identifier, region
update_resource	components	UPDATE	Identifier, PatchDocument, region
list_resources	components_list_only	SELECT	region
get_resource	components	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.amplifyuibuilder.components
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ app_id }}|{{ environment_name }}|{{ id }}';

list (identifiers only)

Lists all components in a region.

SELECT
  region,
  app_id,
  environment_name,
  id
FROM awscc.amplifyuibuilder.components_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.amplifyuibuilder.components (
  AppId,
  BindingProperties,
  Children,
  CollectionProperties,
  ComponentType,
  EnvironmentName,
  Events,
  Name,
  Overrides,
  Properties,
  SchemaVersion,
  SourceId,
  Tags,
  Variants,
  region
)
SELECT
  '{{ app_id }}',
  '{{ binding_properties }}',
  '{{ children }}',
  '{{ collection_properties }}',
  '{{ component_type }}',
  '{{ environment_name }}',
  '{{ events }}',
  '{{ name }}',
  '{{ overrides }}',
  '{{ properties }}',
  '{{ schema_version }}',
  '{{ source_id }}',
  '{{ tags }}',
  '{{ variants }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.amplifyuibuilder.components (
  AppId,
  BindingProperties,
  Children,
  CollectionProperties,
  ComponentType,
  EnvironmentName,
  Events,
  Name,
  Overrides,
  Properties,
  SchemaVersion,
  SourceId,
  Tags,
  Variants,
  region
)
SELECT
  '{{ app_id }}',
  '{{ binding_properties }}',
  '{{ children }}',
  '{{ collection_properties }}',
  '{{ component_type }}',
  '{{ environment_name }}',
  '{{ events }}',
  '{{ name }}',
  '{{ overrides }}',
  '{{ properties }}',
  '{{ schema_version }}',
  '{{ source_id }}',
  '{{ 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: app_id
        value: '{{ app_id }}'
      - name: binding_properties
        value: {}
      - name: children
        value:
          - component_type: '{{ component_type }}'
            name: '{{ name }}'
            properties: {}
            children:
              - null
            events: {}
            source_id: '{{ source_id }}'
      - name: collection_properties
        value: {}
      - name: component_type
        value: '{{ component_type }}'
      - name: environment_name
        value: '{{ environment_name }}'
      - name: events
        value: null
      - name: name
        value: '{{ name }}'
      - name: overrides
        value: {}
      - name: properties
        value: null
      - name: schema_version
        value: '{{ schema_version }}'
      - name: source_id
        value: '{{ source_id }}'
      - name: tags
        value: {}
      - name: variants
        value:
          - variant_values: {}
            overrides: null

UPDATE example

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

/*+ update */
UPDATE awscc.amplifyuibuilder.components
SET PatchDocument = string('{{ {
    "BindingProperties": binding_properties,
    "Children": children,
    "CollectionProperties": collection_properties,
    "ComponentType": component_type,
    "Events": events,
    "Name": name,
    "Overrides": overrides,
    "Properties": properties,
    "SchemaVersion": schema_version,
    "SourceId": source_id,
    "Tags": tags,
    "Variants": variants
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ app_id }}|{{ environment_name }}|{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.amplifyuibuilder.components
WHERE
  Identifier = '{{ app_id }}|{{ environment_name }}|{{ 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