software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.EventDimensionsProperty

All Known Implementing Classes:

CfnCampaign.EventDimensionsProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

public static interface CfnCampaign.EventDimensionsProperty

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

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;
 EventDimensionsProperty eventDimensionsProperty = EventDimensionsProperty.builder()
         .attributes(attributes)
         .eventType(SetDimensionProperty.builder()
                 .dimensionType("dimensionType")
                 .values(List.of("values"))
                 .build())
         .metrics(metrics)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCampaign.EventDimensionsProperty.Builder	builder()
default java.lang.Object	getAttributes() One or more custom attributes that your application reports to Amazon Pinpoint.
default java.lang.Object	getEventType() The name of the event that causes the campaign to be sent or the journey activity to be performed.
default java.lang.Object	getMetrics() One or more custom metrics that your application reports to Amazon Pinpoint .

Method Detail

getAttributes

default java.lang.Object getAttributes()

One or more custom attributes that your application reports to Amazon Pinpoint.

You can use these attributes as selection criteria when you create an event filter.

getEventType

default java.lang.Object getEventType()

The name of the event that causes the campaign to be sent or the journey activity to be performed.

This can be a standard event that Amazon Pinpoint generates, such as _email.delivered or _custom.delivered . For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

getMetrics

default java.lang.Object getMetrics()

One or more custom metrics that your application reports to Amazon Pinpoint .

You can use these metrics as selection criteria when you create an event filter.

builder

static CfnCampaign.EventDimensionsProperty.Builder builder()

Returns:

a CfnCampaign.EventDimensionsProperty.Builder of CfnCampaign.EventDimensionsProperty