AWS CDK Reference

Appearance

v2.275.0

CfnInAppTemplateProps Struct ​

Properties for defining a CfnInAppTemplate.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pinpoint as pinpoint } from 'aws-cdk-lib';

declare const customConfig: any;
declare const tags: any;
const cfnInAppTemplateProps: pinpoint.CfnInAppTemplateProps = {
  templateName: 'templateName',

  // the properties below are optional
  content: [{
    backgroundColor: 'backgroundColor',
    bodyConfig: {
      alignment: 'alignment',
      body: 'body',
      textColor: 'textColor',
    },
    headerConfig: {
      alignment: 'alignment',
      header: 'header',
      textColor: 'textColor',
    },
    imageUrl: 'imageUrl',
    primaryBtn: {
      android: {
        buttonAction: 'buttonAction',
        link: 'link',
      },
      defaultConfig: {
        backgroundColor: 'backgroundColor',
        borderRadius: 123,
        buttonAction: 'buttonAction',
        link: 'link',
        text: 'text',
        textColor: 'textColor',
      },
      ios: {
        buttonAction: 'buttonAction',
        link: 'link',
      },
      web: {
        buttonAction: 'buttonAction',
        link: 'link',
      },
    },
    secondaryBtn: {
      android: {
        buttonAction: 'buttonAction',
        link: 'link',
      },
      defaultConfig: {
        backgroundColor: 'backgroundColor',
        borderRadius: 123,
        buttonAction: 'buttonAction',
        link: 'link',
        text: 'text',
        textColor: 'textColor',
      },
      ios: {
        buttonAction: 'buttonAction',
        link: 'link',
      },
      web: {
        buttonAction: 'buttonAction',
        link: 'link',
      },
    },
  }],
  customConfig: customConfig,
  layout: 'layout',
  tags: tags,
  templateDescription: 'templateDescription',
};

Properties ​

contentoptionalIResolvable | IResolvable | CfnInAppTemplate.InAppMessageContentProperty[]contentoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InAppMessageContentProperty]]]contentoptionalIResolvableContentoptionalIResolvableContentoptionalinterface{}#
An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.
customConfigoptionalanycustom_configoptionalAnycustomConfigoptionalObjectCustomConfigoptionalobjectCustomConfigoptionalinterface{}#
Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
layoutoptionalstringlayoutoptionalstrlayoutoptionalStringLayoutoptionalstringLayoutoptional*string#
A string that determines the appearance of the in-app message. You can specify one of the following:.
notes
  • BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
  • TOP_BANNER – a message that appears as a banner at the top of the page.
  • OVERLAYS – a message that covers entire screen.
  • MOBILE_FEED – a message that appears in a window in front of the page.
  • MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
  • CAROUSEL – a scrollable layout of up to five unique messages.
tagsoptionalanytagsoptionalAnytagsoptionalObjectTagsoptionalobjectTagsoptionalinterface{}#
An array of key-value pairs to apply to this resource.

For more information, see Tag .

templateDescriptionoptionalstringtemplate_descriptionoptionalstrtemplateDescriptionoptionalStringTemplateDescriptionoptionalstringTemplateDescriptionoptional*string#
An optional description of the in-app template.
templateNamestringtemplate_namestrtemplateNameStringTemplateNamestringTemplateName*stringrequired#
The name of the in-app message template.