AWS::Pinpoint::ApplicationSettings CampaignHook - AWS CloudFormation
SyntaxProperties

AWS::Pinpoint::ApplicationSettings CampaignHook

Specifies the Lambda function to use by default as a code hook for campaigns in the application.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "LambdaFunctionName" : String,
  "Mode" : String,
  "WebUrl" : String
}

YAML

  LambdaFunctionName: String
  Mode: String
  WebUrl: String

Properties

LambdaFunctionName

The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.

Required: No

Type: String

Update requires: No interruption

Mode

The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:

  • FILTER - Invoke the function to customize the segment that's used by a campaign.

  • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

Required: No

Type: String

Update requires: No interruption

WebUrl

The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

Required: No

Type: String

Update requires: No interruption