aws-cdk-lib.aws_pinpoint.CfnCampaign.InAppMessageContentProperty

interface InAppMessageContentProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnCampaign.InAppMessageContentProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnCampaign_InAppMessageContentProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnCampaign.InAppMessageContentProperty
Pythonaws_cdk.aws_pinpoint.CfnCampaign.InAppMessageContentProperty
TypeScript aws-cdk-lib » 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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
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

NameTypeDescription
backgroundColor?stringThe background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
bodyConfig?IResolvable | InAppMessageBodyConfigPropertySpecifies the configuration of main body text in an in-app message template.
headerConfig?IResolvable | InAppMessageHeaderConfigPropertySpecifies the configuration and content of the header or title text of the in-app message.
imageUrl?stringThe URL of the image that appears on an in-app message banner.
primaryBtn?IResolvable | InAppMessageButtonPropertyAn object that contains configuration information about the primary button in an in-app message.
secondaryBtn?IResolvable | InAppMessageButtonPropertyAn 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.