AWS::Pinpoint::Campaign CampaignHook - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Pinpoint::Campaign CampaignHook

Specifies settings for invoking an Lambda function that customizes a segment for a campaign.

Syntax

To declare this entity in your Amazon 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 customize a segment for a campaign.

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