aws-cdk-lib.aws_pinpoint.CfnApplicationSettings.CampaignHookProperty

interface CampaignHookProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnApplicationSettings.CampaignHookProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnApplicationSettings_CampaignHookProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnApplicationSettings.CampaignHookProperty
Pythonaws_cdk.aws_pinpoint.CfnApplicationSettings.CampaignHookProperty
TypeScript aws-cdk-lib » 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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
const campaignHookProperty: pinpoint.CfnApplicationSettings.CampaignHookProperty = {
  lambdaFunctionName: 'lambdaFunctionName',
  mode: 'mode',
  webUrl: 'webUrl',
};

Properties

NameTypeDescription
lambdaFunctionName?stringThe name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
mode?stringThe mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:.
webUrl?stringThe 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 the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

webUrl?

Type: string (optional)

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