Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.CampaignHookProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.CampaignHookProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(Stable)
public static interface CfnCampaign.CampaignHookProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.CampaignHookProperty.Builder	builder()
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.
default String	getMode()	The mode that Amazon Pinpoint uses to invoke the Lambda function.
default String	getWebUrl()	The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-lambdafunctionname

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-mode

getWebUrl

@Stability(Stable)
@Nullable
default String getWebUrl()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-weburl

builder

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

Returns:

a CfnCampaign.CampaignHookProperty.Builder of CfnCampaign.CampaignHookProperty