aws-cdk-lib.aws_pinpoint.CfnSegment.SetDimensionProperty

interface SetDimensionProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnSegment.SetDimensionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnSegment_SetDimensionProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnSegment.SetDimensionProperty
Pythonaws_cdk.aws_pinpoint.CfnSegment.SetDimensionProperty
TypeScript aws-cdk-lib » aws_pinpoint » CfnSegment » SetDimensionProperty

Specifies the dimension type and values for a segment dimension.

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 setDimensionProperty: pinpoint.CfnSegment.SetDimensionProperty = {
  dimensionType: 'dimensionType',
  values: ['values'],
};

Properties

NameTypeDescription
dimensionType?stringThe type of segment dimension to use.
values?string[]The criteria values to use for the segment dimension.

dimensionType?

Type: string (optional)

The type of segment dimension to use.

Valid values are: INCLUSIVE , endpoints that match the criteria are included in the segment; and, EXCLUSIVE , endpoints that match the criteria are excluded from the segment.


values?

Type: string[] (optional)

The criteria values to use for the segment dimension.

Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.