Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.CampaignEventFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.CampaignEventFilterProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

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

Specifies the settings for events that cause a campaign to be sent.

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.*;
 Object attributes;
 Object metrics;
 CampaignEventFilterProperty campaignEventFilterProperty = CampaignEventFilterProperty.builder()
         .dimensions(EventDimensionsProperty.builder()
                 .attributes(attributes)
                 .eventType(SetDimensionProperty.builder()
                         .dimensionType("dimensionType")
                         .values(List.of("values"))
                         .build())
                 .metrics(metrics)
                 .build())
         .filterType("filterType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.CampaignEventFilterProperty.Builder	builder()
default Object	getDimensions()	The dimension settings of the event filter for the campaign.
default String	getFilterType()	The type of event that causes the campaign to be sent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensions

@Stability(Stable)
@Nullable
default Object getDimensions()

The dimension settings of the event filter for the campaign.

See Also:

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

getFilterType

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

The type of event that causes the campaign to be sent.

Valid values are: SYSTEM , sends the campaign when a system event occurs; and, ENDPOINT , sends the campaign when an endpoint event (Events resource) occurs.

See Also:

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

builder

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

Returns:

a CfnCampaign.CampaignEventFilterProperty.Builder of CfnCampaign.CampaignEventFilterProperty