interface SegmentGroupsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Pinpoint.CfnSegment.SegmentGroupsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnSegment_SegmentGroupsProperty`
Java	`software.amazon.awscdk.services.pinpoint.CfnSegment.SegmentGroupsProperty`
Python	`aws_cdk.aws_pinpoint.CfnSegment.SegmentGroupsProperty`
TypeScript	`aws-cdk-lib` » `aws_pinpoint` » `CfnSegment` » `SegmentGroupsProperty`

Specifies the set of segment criteria to evaluate when handling segment groups for the segment.

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;
declare const userAttributes: any;
const segmentGroupsProperty: pinpoint.CfnSegment.SegmentGroupsProperty = {
  groups: [{
    dimensions: [{
      attributes: attributes,
      behavior: {
        recency: {
          duration: 'duration',
          recencyType: 'recencyType',
        },
      },
      demographic: {
        appVersion: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        channel: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        deviceType: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        make: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        model: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        platform: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
      },
      location: {
        country: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        gpsPoint: {
          coordinates: {
            latitude: 123,
            longitude: 123,
          },
          rangeInKilometers: 123,
        },
      },
      metrics: metrics,
      userAttributes: userAttributes,
    }],
    sourceSegments: [{
      id: 'id',

      // the properties below are optional
      version: 123,
    }],
    sourceType: 'sourceType',
    type: 'type',
  }],
  include: 'include',
};

Properties

Name	Type	Description
groups?	`IResolvable` `\|` `IResolvable` `\|` `GroupsProperty[]`	Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
include?	`string`	Specifies how to handle multiple segment groups for the segment.

groups?

Type: IResolvable | IResolvable | GroupsProperty[] (optional)

Specifies the set of segment criteria to evaluate when handling segment groups for the segment.

include?

Type: string (optional)

Specifies how to handle multiple segment groups for the segment.

For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.