Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.EventDimensionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.EventDimensionsProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

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

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributes

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getEventType

@Stability(Stable)
@Nullable
default 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 .

Returns union: either IResolvable or CfnCampaign.SetDimensionProperty

See Also:

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

getMetrics

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

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

Returns:

a CfnCampaign.EventDimensionsProperty.Builder of CfnCampaign.EventDimensionsProperty