Interface CfnCampaign.CampaignHookProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnCampaign.CampaignHookProperty extends
Specifies settings for invoking an Lambda function that customizes a segment for a campaign.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CampaignHookProperty campaignHookProperty = CampaignHookProperty.builder()
  • Method Details

    • getLambdaFunctionName

      @Stability(Stable) @Nullable default String getLambdaFunctionName()
      The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
    • getMode

      @Stability(Stable) @Nullable default String getMode()
      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.
    • getWebUrl

      @Stability(Stable) @Nullable default String getWebUrl()
      The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.
    • builder

      @Stability(Stable) static CfnCampaign.CampaignHookProperty.Builder builder()
      a CfnCampaign.CampaignHookProperty.Builder of CfnCampaign.CampaignHookProperty