interface SourceSegmentsProperty

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

Specifies the base segment to build the segment on.

A base segment, also called a source segment , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.

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';
const sourceSegmentsProperty: pinpoint.CfnSegment.SourceSegmentsProperty = {
  id: 'id',

  // the properties below are optional
  version: 123,
};

Properties

Name	Type	Description
id	string	The unique identifier for the source segment.
version?	number	The version number of the source segment.

---

id

Type: string

The unique identifier for the source segment.

---

version?

Type: number (optional)

The version number of the source segment.