Interface CfnSegment.IGroupsProperty
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnSegment.IGroupsPropertySyntax (vb)
Public Interface CfnSegment.IGroupsPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;
var attributes;
var metrics;
var userAttributes;
var groupsProperty = new GroupsProperty {
Dimensions = new [] { new SegmentDimensionsProperty {
Attributes = attributes,
Behavior = new BehaviorProperty {
Recency = new RecencyProperty {
Duration = "duration",
RecencyType = "recencyType"
}
},
Demographic = new DemographicProperty {
AppVersion = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Channel = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
DeviceType = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Make = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Model = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Platform = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
Location = new LocationProperty {
Country = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
GpsPoint = new GPSPointProperty {
Coordinates = new CoordinatesProperty {
Latitude = 123,
Longitude = 123
},
RangeInKilometers = 123
}
},
Metrics = metrics,
UserAttributes = userAttributes
} },
SourceSegments = new [] { new SourceSegmentsProperty {
Id = "id",
// the properties below are optional
Version = 123
} },
SourceType = "sourceType",
Type = "type"
};Synopsis
Properties
| Dimensions | An array that defines the dimensions to include or exclude from the segment. |
| SourceSegments | The base segment to build the segment on. |
| SourceType | Specifies how to handle multiple base segments for the segment. |
| Type | Specifies how to handle multiple dimensions for the segment. |
Properties
Dimensions
An array that defines the dimensions to include or exclude from the segment.
object? Dimensions { get; }Property Value
Remarks
SourceSegments
The base segment to build the segment on.
object? SourceSegments { get; }Property Value
Remarks
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.
Type union: either IResolvable or (either IResolvable or CfnSegment.ISourceSegmentsProperty)[]
SourceType
Specifies how to handle multiple base segments for the segment.
string? SourceType { get; }Property Value
Remarks
For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type
Specifies how to handle multiple dimensions for the segment.
string? Type { get; }Property Value
Remarks
For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.