software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.CampaignHookProperty

All Known Implementing Classes:

CfnCampaign.CampaignHookProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

public static interface CfnCampaign.CampaignHookProperty

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CampaignHookProperty campaignHookProperty = CampaignHookProperty.builder()
         .lambdaFunctionName("lambdaFunctionName")
         .mode("mode")
         .webUrl("webUrl")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCampaign.CampaignHookProperty.Builder A builder for CfnCampaign.CampaignHookProperty
static class	CfnCampaign.CampaignHookProperty.Jsii$Proxy An implementation for CfnCampaign.CampaignHookProperty

Method Summary

Modifier and Type	Method and Description
static CfnCampaign.CampaignHookProperty.Builder	builder()
default java.lang.String	getLambdaFunctionName() The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
default java.lang.String	getMode() The mode that Amazon Pinpoint uses to invoke the Lambda function.
default java.lang.String	getWebUrl() The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

Method Detail

getLambdaFunctionName

default java.lang.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

default java.lang.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

default java.lang.String getWebUrl()

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

builder

static CfnCampaign.CampaignHookProperty.Builder builder()

Returns:

a CfnCampaign.CampaignHookProperty.Builder of CfnCampaign.CampaignHookProperty