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	awscc.pinpoint.in_app_templates

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
template_name	string
region	string	AWS region.

For more information, see AWS::Pinpoint::InAppTemplate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	in_app_templates	INSERT	TemplateName, region
delete_resource	in_app_templates	DELETE	Identifier, region
update_resource	in_app_templates	UPDATE	Identifier, PatchDocument, region
list_resources	in_app_templates_list_only	SELECT	region
get_resource	in_app_templates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual in_app_template.

SELECT
  region,
  arn,
  content,
  custom_config,
  layout,
  tags,
  template_description,
  template_name
FROM awscc.pinpoint.in_app_templates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ template_name }}';

list (identifiers only)

Lists all in_app_templates in a region.

SELECT
  region,
  template_name
FROM awscc.pinpoint.in_app_templates_list_only
WHERE
  region = 'us-east-1';

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 awscc.pinpoint.in_app_templates (
  TemplateName,
  region
)
SELECT
  '{{ template_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.pinpoint.in_app_templates (
  Content,
  CustomConfig,
  Layout,
  Tags,
  TemplateDescription,
  TemplateName,
  region
)
SELECT
  '{{ content }}',
  '{{ custom_config }}',
  '{{ layout }}',
  '{{ tags }}',
  '{{ template_description }}',
  '{{ template_name }}',
  '{{ 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:
          - background_color: '{{ background_color }}'
            body_config:
              alignment: '{{ alignment }}'
              body: '{{ body }}'
              text_color: '{{ text_color }}'
            header_config:
              alignment: null
              header: '{{ header }}'
              text_color: '{{ text_color }}'
            image_url: '{{ image_url }}'
            primary_btn:
              android:
                button_action: '{{ button_action }}'
                link: '{{ link }}'
              default_config:
                background_color: '{{ background_color }}'
                border_radius: '{{ border_radius }}'
                button_action: null
                link: '{{ link }}'
                text: '{{ text }}'
                text_color: '{{ text_color }}'
              i_os: null
              web: null
            secondary_btn: null
      - name: custom_config
        value: {}
      - name: layout
        value: '{{ layout }}'
      - name: tags
        value: {}
      - name: template_description
        value: '{{ template_description }}'
      - name: template_name
        value: '{{ template_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.pinpoint.in_app_templates
SET PatchDocument = string('{{ {
    "Content": content,
    "CustomConfig": custom_config,
    "Layout": layout,
    "Tags": tags,
    "TemplateDescription": template_description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ template_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.pinpoint.in_app_templates
WHERE
  Identifier = '{{ template_name }}' 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,
mobiletargeting:TagResource,
mobiletargeting:UntagResource