Interface ICfnSegmentProps
Properties for defining a CfnSegment
.
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnSegmentProps
Syntax (vb)
Public Interface ICfnSegmentProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html
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 tags;
var userAttributes;
var cfnSegmentProps = new CfnSegmentProps {
ApplicationId = "applicationId",
Name = "name",
// the properties below are optional
Dimensions = 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
},
SegmentGroups = new SegmentGroupsProperty {
Groups = new [] { 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"
} },
Include = "include"
},
Tags = tags
};
Synopsis
Properties
ApplicationId | The unique identifier for the Amazon Pinpoint application that the segment is associated with. |
Dimensions | An array that defines the dimensions for the segment. |
Name | The name of the segment. |
SegmentGroups | The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. |
Tags | An array of key-value pairs to apply to this resource. |
Properties
ApplicationId
The unique identifier for the Amazon Pinpoint application that the segment is associated with.
string ApplicationId { get; }
Property Value
System.String
Remarks
Dimensions
An array that defines the dimensions for the segment.
virtual object Dimensions { get; }
Property Value
System.Object
Remarks
Name
The name of the segment.
string Name { get; }
Property Value
System.String
Remarks
A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
SegmentGroups
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
virtual object SegmentGroups { get; }
Property Value
System.Object
Remarks
A segment group can consist of zero or more base segments. Your request can include only one segment group.
Tags
An array of key-value pairs to apply to this resource.
virtual object Tags { get; }
Property Value
System.Object
Remarks
For more information, see Tag .