themes

Creates, updates, deletes or gets a theme resource or lists themes in a region

Overview

Name	themes
Type	Resource
Description	Definition of AWS::AmplifyUIBuilder::Theme Resource Type
Id	aws.amplifyuibuilder.themes

Fields

Name	Datatype	Description
app_id	string
created_at	string
environment_name	string
id	string
modified_at	string
name	string
overrides	array
tags	object
values	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 themes in a region.

SELECT
region,
app_id,
created_at,
environment_name,
id,
modified_at,
name,
overrides,
tags,
values
FROM aws.amplifyuibuilder.themes
WHERE region = 'us-east-1';

Gets all properties from an individual theme.

SELECT
region,
app_id,
created_at,
environment_name,
id,
modified_at,
name,
overrides,
tags,
values
FROM aws.amplifyuibuilder.themes
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 theme resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.amplifyuibuilder.themes (
 AppId,
 EnvironmentName,
 Name,
 Overrides,
 Tags,
 Values,
 region
)
SELECT 
'{{ AppId }}',
 '{{ EnvironmentName }}',
 '{{ Name }}',
 '{{ Overrides }}',
 '{{ Tags }}',
 '{{ Values }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.amplifyuibuilder.themes (
 AppId,
 EnvironmentName,
 Name,
 Overrides,
 Tags,
 Values,
 region
)
SELECT 
 '{{ AppId }}',
 '{{ EnvironmentName }}',
 '{{ Name }}',
 '{{ Overrides }}',
 '{{ Tags }}',
 '{{ Values }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: theme
    props:
      - name: AppId
        value: '{{ AppId }}'
      - name: EnvironmentName
        value: '{{ EnvironmentName }}'
      - name: Name
        value: '{{ Name }}'
      - name: Overrides
        value:
          - Key: '{{ Key }}'
            Value:
              Value: '{{ Value }}'
              Children:
                - null
      - name: Tags
        value: {}
      - name: Values
        value:
          - null

DELETE example

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

Permissions

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

Create

amplify:GetApp,
amplifyuibuilder:CreateTheme,
amplifyuibuilder:GetTheme,
amplifyuibuilder:TagResource

Read

amplify:GetApp,
amplifyuibuilder:GetTheme

Update

amplify:GetApp,
amplifyuibuilder:GetTheme,
amplifyuibuilder:TagResource,
amplifyuibuilder:UntagResource,
amplifyuibuilder:UpdateTheme

Delete

amplify:GetApp,
amplifyuibuilder:DeleteTheme,
amplifyuibuilder:UntagResource

List

amplify:GetApp,
amplifyuibuilder:ListThemes