CfnSegmentPropsMixin

class aws_cdk.mixins_preview.aws_pinpoint.mixins.CfnSegmentPropsMixin(props, *, strategy=None)

Bases: Mixin

Updates the configuration, dimension, and other settings for an existing segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html
CloudformationResource:: AWS::Pinpoint::Segment
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

# attributes: Any
# metrics: Any
# tags: Any
# user_attributes: Any

cfn_segment_props_mixin = pinpoint_mixins.CfnSegmentPropsMixin(pinpoint_mixins.CfnSegmentMixinProps(
    application_id="applicationId",
    dimensions=pinpoint_mixins.CfnSegmentPropsMixin.SegmentDimensionsProperty(
        attributes=attributes,
        behavior=pinpoint_mixins.CfnSegmentPropsMixin.BehaviorProperty(
            recency=pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
                duration="duration",
                recency_type="recencyType"
            )
        ),
        demographic=pinpoint_mixins.CfnSegmentPropsMixin.DemographicProperty(
            app_version=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            channel=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            device_type=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            make=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            model=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            platform=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            )
        ),
        location=pinpoint_mixins.CfnSegmentPropsMixin.LocationProperty(
            country=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            gps_point=pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
                coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
                    latitude=123,
                    longitude=123
                ),
                range_in_kilometers=123
            )
        ),
        metrics=metrics,
        user_attributes=user_attributes
    ),
    name="name",
    segment_groups=pinpoint_mixins.CfnSegmentPropsMixin.SegmentGroupsProperty(
        groups=[pinpoint_mixins.CfnSegmentPropsMixin.GroupsProperty(
            dimensions=[pinpoint_mixins.CfnSegmentPropsMixin.SegmentDimensionsProperty(
                attributes=attributes,
                behavior=pinpoint_mixins.CfnSegmentPropsMixin.BehaviorProperty(
                    recency=pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
                        duration="duration",
                        recency_type="recencyType"
                    )
                ),
                demographic=pinpoint_mixins.CfnSegmentPropsMixin.DemographicProperty(
                    app_version=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    channel=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    device_type=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    make=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    model=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    platform=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    )
                ),
                location=pinpoint_mixins.CfnSegmentPropsMixin.LocationProperty(
                    country=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    gps_point=pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
                        coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
                            latitude=123,
                            longitude=123
                        ),
                        range_in_kilometers=123
                    )
                ),
                metrics=metrics,
                user_attributes=user_attributes
            )],
            source_segments=[pinpoint_mixins.CfnSegmentPropsMixin.SourceSegmentsProperty(
                id="id",
                version=123
            )],
            source_type="sourceType",
            type="type"
        )],
        include="include"
    ),
    tags=tags
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Pinpoint::Segment.

Parameters:

props (Union[CfnSegmentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationId', 'dimensions', 'name', 'segmentGroups', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BehaviorProperty

class CfnSegmentPropsMixin.BehaviorProperty(*, recency=None)

Bases: object

Specifies behavior-based criteria for the segment, such as how recently users have used your app.

Parameters:: recency (Union[IResolvable, RecencyProperty, Dict[str, Any], None]) – Specifies how recently segment members were active.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-behavior.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

behavior_property = pinpoint_mixins.CfnSegmentPropsMixin.BehaviorProperty(
    recency=pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
        duration="duration",
        recency_type="recencyType"
    )
)

Attributes

recency

Specifies how recently segment members were active.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-behavior.html#cfn-pinpoint-segment-behavior-recency

CoordinatesProperty

class CfnSegmentPropsMixin.CoordinatesProperty(*, latitude=None, longitude=None)

Bases: object

Specifies the GPS coordinates of a location.

Parameters:

latitude (Union[int, float, None]) – The latitude coordinate of the location.
longitude (Union[int, float, None]) – The longitude coordinate of the location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

coordinates_property = pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
    latitude=123,
    longitude=123
)

Attributes

latitude

The latitude coordinate of the location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html#cfn-pinpoint-segment-coordinates-latitude

longitude

The longitude coordinate of the location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html#cfn-pinpoint-segment-coordinates-longitude

DemographicProperty

class CfnSegmentPropsMixin.DemographicProperty(*, app_version=None, channel=None, device_type=None, make=None, model=None, platform=None)

Bases: object

Specifies demographic-based criteria, such as device platform, for the segment.

Parameters:

app_version (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The app version criteria for the segment.
channel (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The channel criteria for the segment.
device_type (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The device type criteria for the segment.
make (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The device make criteria for the segment.
model (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The device model criteria for the segment.
platform (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The device platform criteria for the segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

demographic_property = pinpoint_mixins.CfnSegmentPropsMixin.DemographicProperty(
    app_version=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    ),
    channel=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    ),
    device_type=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    ),
    make=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    ),
    model=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    ),
    platform=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    )
)

Attributes

app_version

The app version criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-appversion

channel

The channel criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-channel

device_type

The device type criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-devicetype

make

The device make criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-make

model

The device model criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-model

platform

The device platform criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-platform

GPSPointProperty

class CfnSegmentPropsMixin.GPSPointProperty(*, coordinates=None, range_in_kilometers=None)

Bases: object

Specifies the GPS coordinates of the endpoint location.

Parameters:

coordinates (Union[IResolvable, CoordinatesProperty, Dict[str, Any], None]) – The GPS coordinates to measure distance from.
range_in_kilometers (Union[int, float, None]) – The range, in kilometers, from the GPS coordinates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

g_pSPoint_property = pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
    coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
        latitude=123,
        longitude=123
    ),
    range_in_kilometers=123
)

Attributes

coordinates

The GPS coordinates to measure distance from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html#cfn-pinpoint-segment-gpspoint-coordinates

range_in_kilometers

The range, in kilometers, from the GPS coordinates.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html#cfn-pinpoint-segment-gpspoint-rangeinkilometers

GroupsProperty

class CfnSegmentPropsMixin.GroupsProperty(*, dimensions=None, source_segments=None, source_type=None, type=None)

Bases: object

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

Parameters:

dimensions (Union[IResolvable, Sequence[Union[IResolvable, SegmentDimensionsProperty, Dict[str, Any]]], None]) – An array that defines the dimensions to include or exclude from the segment.
source_segments (Union[IResolvable, Sequence[Union[IResolvable, SourceSegmentsProperty, Dict[str, Any]]], None]) – 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.
source_type (Optional[str]) – Specifies how to handle multiple base segments for the segment. 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 (Optional[str]) – Specifies how to handle multiple dimensions for the segment. 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

# attributes: Any
# metrics: Any
# user_attributes: Any

groups_property = pinpoint_mixins.CfnSegmentPropsMixin.GroupsProperty(
    dimensions=[pinpoint_mixins.CfnSegmentPropsMixin.SegmentDimensionsProperty(
        attributes=attributes,
        behavior=pinpoint_mixins.CfnSegmentPropsMixin.BehaviorProperty(
            recency=pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
                duration="duration",
                recency_type="recencyType"
            )
        ),
        demographic=pinpoint_mixins.CfnSegmentPropsMixin.DemographicProperty(
            app_version=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            channel=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            device_type=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            make=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            model=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            platform=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            )
        ),
        location=pinpoint_mixins.CfnSegmentPropsMixin.LocationProperty(
            country=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            gps_point=pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
                coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
                    latitude=123,
                    longitude=123
                ),
                range_in_kilometers=123
            )
        ),
        metrics=metrics,
        user_attributes=user_attributes
    )],
    source_segments=[pinpoint_mixins.CfnSegmentPropsMixin.SourceSegmentsProperty(
        id="id",
        version=123
    )],
    source_type="sourceType",
    type="type"
)

Attributes

dimensions

An array that defines the dimensions to include or exclude from the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-dimensions

source_segments

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-sourcesegments

source_type

Specifies how to handle multiple base segments for the segment.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-sourcetype

type

Specifies how to handle multiple dimensions for the segment.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-type

LocationProperty

class CfnSegmentPropsMixin.LocationProperty(*, country=None, gps_point=None)

Bases: object

Specifies location-based criteria, such as region or GPS coordinates, for the segment.

Parameters:

country (Union[IResolvable, SetDimensionProperty, Dict[str, Any], None]) – The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
gps_point (Union[IResolvable, GPSPointProperty, Dict[str, Any], None]) – The GPS point dimension for the segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

location_property = pinpoint_mixins.CfnSegmentPropsMixin.LocationProperty(
    country=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
        dimension_type="dimensionType",
        values=["values"]
    ),
    gps_point=pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
        coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
            latitude=123,
            longitude=123
        ),
        range_in_kilometers=123
    )
)

Attributes

country

The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html#cfn-pinpoint-segment-location-country

gps_point

The GPS point dimension for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html#cfn-pinpoint-segment-location-gpspoint

RecencyProperty

class CfnSegmentPropsMixin.RecencyProperty(*, duration=None, recency_type=None)

Bases: object

Specifies how recently segment members were active.

Parameters:

duration (Optional[str]) – The duration to use when determining which users have been active or inactive with your app. Possible values: HR_24 | DAY_7 | DAY_14 | DAY_30 .
recency_type (Optional[str]) – The type of recency dimension to use for the segment. Valid values are: ACTIVE and INACTIVE . If the value is ACTIVE , the segment includes users who have used your app within the specified duration are included in the segment. If the value is INACTIVE , the segment includes users who haven’t used your app within the specified duration are included in the segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

recency_property = pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
    duration="duration",
    recency_type="recencyType"
)

Attributes

duration

The duration to use when determining which users have been active or inactive with your app.

Possible values: HR_24 | DAY_7 | DAY_14 | DAY_30 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html#cfn-pinpoint-segment-recency-duration

recency_type

The type of recency dimension to use for the segment.

Valid values are: ACTIVE and INACTIVE . If the value is ACTIVE , the segment includes users who have used your app within the specified duration are included in the segment. If the value is INACTIVE , the segment includes users who haven’t used your app within the specified duration are included in the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html#cfn-pinpoint-segment-recency-recencytype

SegmentDimensionsProperty

class CfnSegmentPropsMixin.SegmentDimensionsProperty(*, attributes=None, behavior=None, demographic=None, location=None, metrics=None, user_attributes=None)

Bases: object

Specifies the dimension settings for a segment.

Parameters:

attributes (Any) – One or more custom attributes to use as criteria for the segment. For more information see AttributeDimension
behavior (Union[IResolvable, BehaviorProperty, Dict[str, Any], None]) – The behavior-based criteria, such as how recently users have used your app, for the segment.
demographic (Union[IResolvable, DemographicProperty, Dict[str, Any], None]) – The demographic-based criteria, such as device platform, for the segment.
location (Union[IResolvable, LocationProperty, Dict[str, Any], None]) – The location-based criteria, such as region or GPS coordinates, for the segment.
metrics (Any) – One or more custom metrics to use as criteria for the segment.
user_attributes (Any) – One or more custom user attributes to use as criteria for the segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

# attributes: Any
# metrics: Any
# user_attributes: Any

segment_dimensions_property = pinpoint_mixins.CfnSegmentPropsMixin.SegmentDimensionsProperty(
    attributes=attributes,
    behavior=pinpoint_mixins.CfnSegmentPropsMixin.BehaviorProperty(
        recency=pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
            duration="duration",
            recency_type="recencyType"
        )
    ),
    demographic=pinpoint_mixins.CfnSegmentPropsMixin.DemographicProperty(
        app_version=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        ),
        channel=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        ),
        device_type=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        ),
        make=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        ),
        model=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        ),
        platform=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        )
    ),
    location=pinpoint_mixins.CfnSegmentPropsMixin.LocationProperty(
        country=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
            dimension_type="dimensionType",
            values=["values"]
        ),
        gps_point=pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
            coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
                latitude=123,
                longitude=123
            ),
            range_in_kilometers=123
        )
    ),
    metrics=metrics,
    user_attributes=user_attributes
)

Attributes

attributes

One or more custom attributes to use as criteria for the segment.

For more information see AttributeDimension

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-attributes

behavior

The behavior-based criteria, such as how recently users have used your app, for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-behavior

demographic

The demographic-based criteria, such as device platform, for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-demographic

location

The location-based criteria, such as region or GPS coordinates, for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-location

metrics

One or more custom metrics to use as criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-metrics

user_attributes

One or more custom user attributes to use as criteria for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-userattributes

SegmentGroupsProperty

class CfnSegmentPropsMixin.SegmentGroupsProperty(*, groups=None, include=None)

Bases: object

Specifies the set of segment criteria to evaluate when handling segment groups for the segment.

Parameters:

groups (Union[IResolvable, Sequence[Union[IResolvable, GroupsProperty, Dict[str, Any]]], None]) – Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
include (Optional[str]) – Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

# attributes: Any
# metrics: Any
# user_attributes: Any

segment_groups_property = pinpoint_mixins.CfnSegmentPropsMixin.SegmentGroupsProperty(
    groups=[pinpoint_mixins.CfnSegmentPropsMixin.GroupsProperty(
        dimensions=[pinpoint_mixins.CfnSegmentPropsMixin.SegmentDimensionsProperty(
            attributes=attributes,
            behavior=pinpoint_mixins.CfnSegmentPropsMixin.BehaviorProperty(
                recency=pinpoint_mixins.CfnSegmentPropsMixin.RecencyProperty(
                    duration="duration",
                    recency_type="recencyType"
                )
            ),
            demographic=pinpoint_mixins.CfnSegmentPropsMixin.DemographicProperty(
                app_version=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                ),
                channel=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                ),
                device_type=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                ),
                make=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                ),
                model=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                ),
                platform=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                )
            ),
            location=pinpoint_mixins.CfnSegmentPropsMixin.LocationProperty(
                country=pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
                    dimension_type="dimensionType",
                    values=["values"]
                ),
                gps_point=pinpoint_mixins.CfnSegmentPropsMixin.GPSPointProperty(
                    coordinates=pinpoint_mixins.CfnSegmentPropsMixin.CoordinatesProperty(
                        latitude=123,
                        longitude=123
                    ),
                    range_in_kilometers=123
                )
            ),
            metrics=metrics,
            user_attributes=user_attributes
        )],
        source_segments=[pinpoint_mixins.CfnSegmentPropsMixin.SourceSegmentsProperty(
            id="id",
            version=123
        )],
        source_type="sourceType",
        type="type"
    )],
    include="include"
)

Attributes

groups

Specifies the set of segment criteria to evaluate when handling segment groups for the segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-groups

include

Specifies how to handle multiple segment groups for the segment.

For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-include

SetDimensionProperty

class CfnSegmentPropsMixin.SetDimensionProperty(*, dimension_type=None, values=None)

Bases: object

Specifies the dimension type and values for a segment dimension.

Parameters:

dimension_type (Optional[str]) – 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 (Optional[Sequence[str]]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

set_dimension_property = pinpoint_mixins.CfnSegmentPropsMixin.SetDimensionProperty(
    dimension_type="dimensionType",
    values=["values"]
)

Attributes

dimension_type

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-dimensiontype

values

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-values

SourceSegmentsProperty

class CfnSegmentPropsMixin.SourceSegmentsProperty(*, id=None, version=None)

Bases: object

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.

Parameters:

id (Optional[str]) – The unique identifier for the source segment.
version (Union[int, float, None]) – The version number of the source segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

source_segments_property = pinpoint_mixins.CfnSegmentPropsMixin.SourceSegmentsProperty(
    id="id",
    version=123
)

Attributes

id

The unique identifier for the source segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html#cfn-pinpoint-segment-sourcesegments-id

version

The version number of the source segment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html#cfn-pinpoint-segment-sourcesegments-version