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

Fields

get (all properties)

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.

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::Theme.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual theme.

SELECT
  region,
  app_id,
  created_at,
  environment_name,
  id,
  modified_at,
  name,
  overrides,
  tags,
  values
FROM awscc.amplifyuibuilder.themes
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ app_id }}|{{ environment_name }}|{{ id }}';

list (identifiers only)

Lists all themes in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.amplifyuibuilder.themes (
  AppId,
  EnvironmentName,
  Name,
  Overrides,
  Tags,
  Values,
  region
)
SELECT
  '{{ app_id }}',
  '{{ environment_name }}',
  '{{ name }}',
  '{{ overrides }}',
  '{{ tags }}',
  '{{ values }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.amplifyuibuilder.themes (
  AppId,
  EnvironmentName,
  Name,
  Overrides,
  Tags,
  Values,
  region
)
SELECT
  '{{ app_id }}',
  '{{ environment_name }}',
  '{{ 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: app_id
        value: '{{ app_id }}'
      - name: environment_name
        value: '{{ environment_name }}'
      - name: name
        value: '{{ name }}'
      - name: overrides
        value:
          - key: '{{ key }}'
            value:
              value: '{{ value }}'
              children:
                - null
      - name: tags
        value: {}
      - name: values
        value:
          - null

UPDATE example

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

/*+ update */
UPDATE awscc.amplifyuibuilder.themes
SET PatchDocument = string('{{ {
    "Name": name,
    "Overrides": overrides,
    "Tags": tags,
    "Values": values
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ app_id }}|{{ environment_name }}|{{ id }}';

DELETE example

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