interface CfnSegmentProps

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

Properties for defining a CfnSegment.

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 tags: any;
declare const userAttributes: any;
const cfnSegmentProps: pinpoint.CfnSegmentProps = {
  applicationId: 'applicationId',
  name: 'name',

  // the properties below are optional
  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,
  },
  segmentGroups: {
    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',
  },
  tags: tags,
};

Properties

Name	Type	Description
applicationId	string	The unique identifier for the Amazon Pinpoint application that the segment is associated with.
name	string	The name of the segment.
dimensions?	IResolvable | SegmentDimensionsProperty	The criteria that define the dimensions for the segment.
segmentGroups?	IResolvable | SegmentGroupsProperty	The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
tags?	any	An array of key-value pairs to apply to this resource.

---

applicationId

Type: string

The unique identifier for the Amazon Pinpoint application that the segment is associated with.

---

name

Type: string

The name of the segment.

A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.

---

dimensions?

Type: IResolvable | SegmentDimensionsProperty (optional)

The criteria that define the dimensions for the segment.

---

segmentGroups?

Type: IResolvable | SegmentGroupsProperty (optional)

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.

A segment group can consist of zero or more base segments. Your request can include only one segment group.

---

tags?

Type: any (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .