in_app_templates

Creates, updates, deletes or gets an in_app_template resource or lists in_app_templates in a region

Overview

Name	in_app_templates
Type	Resource
Description	Resource Type definition for AWS::Pinpoint::InAppTemplate
Id	aws.pinpoint.in_app_templates

Fields

Name	Datatype	Description
arn	string
content	array
custom_config	object
layout	string
tags	object
template_description	string
template_name	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TemplateName, 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 in_app_templates in a region.

SELECT
region,
arn,
content,
custom_config,
layout,
tags,
template_description,
template_name
FROM aws.pinpoint.in_app_templates
WHERE region = 'us-east-1';

Gets all properties from an individual in_app_template.

SELECT
region,
arn,
content,
custom_config,
layout,
tags,
template_description,
template_name
FROM aws.pinpoint.in_app_templates
WHERE region = 'us-east-1' AND data__Identifier = '<TemplateName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.pinpoint.in_app_templates (
 TemplateName,
 region
)
SELECT 
'{{ TemplateName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.pinpoint.in_app_templates (
 Content,
 CustomConfig,
 Layout,
 Tags,
 TemplateDescription,
 TemplateName,
 region
)
SELECT 
 '{{ Content }}',
 '{{ CustomConfig }}',
 '{{ Layout }}',
 '{{ Tags }}',
 '{{ TemplateDescription }}',
 '{{ TemplateName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: in_app_template
    props:
      - name: Content
        value:
          - BackgroundColor: '{{ BackgroundColor }}'
            BodyConfig:
              Alignment: '{{ Alignment }}'
              Body: '{{ Body }}'
              TextColor: '{{ TextColor }}'
            HeaderConfig:
              Alignment: null
              Header: '{{ Header }}'
              TextColor: '{{ TextColor }}'
            ImageUrl: '{{ ImageUrl }}'
            PrimaryBtn:
              Android:
                ButtonAction: '{{ ButtonAction }}'
                Link: '{{ Link }}'
              DefaultConfig:
                BackgroundColor: '{{ BackgroundColor }}'
                BorderRadius: '{{ BorderRadius }}'
                ButtonAction: null
                Link: '{{ Link }}'
                Text: '{{ Text }}'
                TextColor: '{{ TextColor }}'
              IOS: null
              Web: null
            SecondaryBtn: null
      - name: CustomConfig
        value: {}
      - name: Layout
        value: '{{ Layout }}'
      - name: Tags
        value: {}
      - name: TemplateDescription
        value: '{{ TemplateDescription }}'
      - name: TemplateName
        value: '{{ TemplateName }}'

DELETE example

/*+ delete */
DELETE FROM aws.pinpoint.in_app_templates
WHERE data__Identifier = '<TemplateName>'
AND region = 'us-east-1';

Permissions

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

Create

mobiletargeting:CreateInAppTemplate,
mobiletargeting:GetInAppTemplate,
mobiletargeting:TagResource

Delete

mobiletargeting:DeleteInAppTemplate,
mobiletargeting:GetInAppTemplate

List

mobiletargeting:GetInAppTemplate,
mobiletargeting:ListTemplates

Read

mobiletargeting:GetInAppTemplate,
mobiletargeting:ListTemplates

Update

mobiletargeting:UpdateInAppTemplate,
mobiletargeting:GetInAppTemplate