aws-cdk-lib.aws_pinpoint.CfnCampaign.EventDimensionsProperty

interface EventDimensionsProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnCampaign.EventDimensionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnCampaign_EventDimensionsProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnCampaign.EventDimensionsProperty
Pythonaws_cdk.aws_pinpoint.CfnCampaign.EventDimensionsProperty
TypeScript aws-cdk-lib » aws_pinpoint » 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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';

declare const attributes: any;
declare const metrics: any;
const eventDimensionsProperty: pinpoint.CfnCampaign.EventDimensionsProperty = {
  attributes: attributes,
  eventType: {
    dimensionType: 'dimensionType',
    values: ['values'],
  },
  metrics: metrics,
};

Properties

NameTypeDescription
attributes?anyOne or more custom attributes that your application reports to Amazon Pinpoint.
eventType?IResolvable | SetDimensionPropertyThe name of the event that causes the campaign to be sent or the journey activity to be performed.
metrics?anyOne or more custom metrics that your application reports to Amazon Pinpoint .

attributes?

Type: any (optional)

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.


eventType?

Type: IResolvable | SetDimensionProperty (optional)

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 .


metrics?

Type: any (optional)

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.