interface InAppMessageContentProperty

Language	Type name
.NET	Amazon.CDK.AWS.Pinpoint.CfnCampaign.InAppMessageContentProperty
Java	software.amazon.awscdk.services.pinpoint.CfnCampaign.InAppMessageContentProperty
Python	aws_cdk.aws_pinpoint.CfnCampaign.InAppMessageContentProperty
TypeScript	@aws-cdk/aws-pinpoint » CfnCampaign » InAppMessageContentProperty

Specifies the configuration and contents of an in-app message.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pinpoint from '@aws-cdk/aws-pinpoint';
const inAppMessageContentProperty: pinpoint.CfnCampaign.InAppMessageContentProperty = {
  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',
    },
  },
};

Properties

Name	Type	Description
backgroundColor?	string	The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
bodyConfig?	IResolvable | InAppMessageBodyConfigProperty	Specifies the configuration of main body text in an in-app message template.
headerConfig?	IResolvable | InAppMessageHeaderConfigProperty	Specifies the configuration and content of the header or title text of the in-app message.
imageUrl?	string	The URL of the image that appears on an in-app message banner.
primaryBtn?	IResolvable | InAppMessageButtonProperty	An object that contains configuration information about the primary button in an in-app message.
secondaryBtn?	IResolvable | InAppMessageButtonProperty	An object that contains configuration information about the secondary button in an in-app message.

---

backgroundColor?

Type: string (optional)

The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).

---

bodyConfig?

Type: IResolvable | InAppMessageBodyConfigProperty (optional)

Specifies the configuration of main body text in an in-app message template.

---

headerConfig?

Type: IResolvable | InAppMessageHeaderConfigProperty (optional)

Specifies the configuration and content of the header or title text of the in-app message.

---

imageUrl?

Type: string (optional)

The URL of the image that appears on an in-app message banner.

---

primaryBtn?

Type: IResolvable | InAppMessageButtonProperty (optional)

An object that contains configuration information about the primary button in an in-app message.

---

secondaryBtn?

Type: IResolvable | InAppMessageButtonProperty (optional)

An object that contains configuration information about the secondary button in an in-app message.