Package software.amazon.awscdk.services.pinpoint

Interface CfnApplicationSettings.CampaignHookProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationSettings.CampaignHookProperty.Jsii$Proxy

Enclosing class:

CfnApplicationSettings

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

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 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-applicationsettings-campaignhook.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplicationSettings.CampaignHookProperty.Builder	builder()
default String	getLambdaFunctionName()	The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
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 send messages for campaigns in the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-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-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-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-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-weburl

builder

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

Returns:

a CfnApplicationSettings.CampaignHookProperty.Builder of CfnApplicationSettings.CampaignHookProperty