aws-cdk-lib.aws_pinpoint.CfnSegment.SegmentDimensionsProperty

interface SegmentDimensionsProperty

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

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

NameTypeDescription
attributes?anyOne or more custom attributes to use as criteria for the segment.
behavior?IResolvable | BehaviorPropertyThe behavior-based criteria, such as how recently users have used your app, for the segment.
demographic?IResolvable | DemographicPropertyThe demographic-based criteria, such as device platform, for the segment.
location?IResolvable | LocationPropertyThe location-based criteria, such as region or GPS coordinates, for the segment.
metrics?anyOne or more custom metrics to use as criteria for the segment.
userAttributes?anyOne or more custom user attributes to use as criteria for the segment.

attributes?

Type: any (optional)

One or more custom attributes to use as criteria for the segment.

For more information see AttributeDimension


behavior?

Type: IResolvable | BehaviorProperty (optional)

The behavior-based criteria, such as how recently users have used your app, for the segment.


demographic?

Type: IResolvable | DemographicProperty (optional)

The demographic-based criteria, such as device platform, for the segment.


location?

Type: IResolvable | LocationProperty (optional)

The location-based criteria, such as region or GPS coordinates, for the segment.


metrics?

Type: any (optional)

One or more custom metrics to use as criteria for the segment.


userAttributes?

Type: any (optional)

One or more custom user attributes to use as criteria for the segment.