interface SegmentDimensionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Pinpoint.CfnSegment.SegmentDimensionsProperty`
Java	`software.amazon.awscdk.services.pinpoint.CfnSegment.SegmentDimensionsProperty`
Python	`aws_cdk.aws_pinpoint.CfnSegment.SegmentDimensionsProperty`
TypeScript	`@aws-cdk/aws-pinpoint` » `CfnSegment` » `SegmentDimensionsProperty`

Specifies the dimension settings for a segment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pinpoint from '@aws-cdk/aws-pinpoint';

declare const attributes: any;
declare const metrics: any;
declare const userAttributes: any;
const segmentDimensionsProperty: pinpoint.CfnSegment.SegmentDimensionsProperty = {
  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,
};

Properties

Name	Type	Description
attributes?	`any`	One or more custom attributes to use as criteria for the segment.
behavior?	`IResolvable` `\|` `BehaviorProperty`	The behavior-based criteria, such as how recently users have used your app, for the segment.
demographic?	`IResolvable` `\|` `DemographicProperty`	The demographic-based criteria, such as device platform, for the segment.
location?	`IResolvable` `\|` `LocationProperty`	The location-based criteria, such as region or GPS coordinates, for the segment.
metrics?	`any`	One or more custom metrics to use as criteria for the segment.
userAttributes?	`any`	One or more custom user attributes to use as criteria for the segment.