interface CampaignHookProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Pinpoint.CfnApplicationSettings.CampaignHookProperty |
 Java | software.amazon.awscdk.services.pinpoint.CfnApplicationSettings.CampaignHookProperty |
 Python | aws_cdk.aws_pinpoint.CfnApplicationSettings.CampaignHookProperty |
 TypeScript | @aws-cdk/aws-pinpoint » CfnApplicationSettings » CampaignHookProperty |
Specifies the Lambda function to use by default as a code hook for campaigns in the application.
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 campaignHookProperty: pinpoint.CfnApplicationSettings.CampaignHookProperty = {
lambdaFunctionName: 'lambdaFunctionName',
mode: 'mode',
webUrl: 'webUrl',
};
Properties
| Name | Type | Description |
|---|---|---|
| lambda | string | The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application. |
| mode? | string | The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:. |
| web | string | The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS. |
lambdaFunctionName?
Type:
string
(optional)
The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
mode?
Type:
string
(optional)
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 theCustomDeliveryConfigurationandCampaignCustomMessageobjects of the campaign.
webUrl?
Type:
string
(optional)
The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.