aws-cdk-lib.aws_pinpoint.CfnSegment.SourceSegmentsProperty

interface SourceSegmentsProperty

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

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

Properties

NameTypeDescription
idstringThe unique identifier for the source segment.
version?numberThe 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.