CfnSegmentProps

class aws_cdk.aws_pinpoint.CfnSegmentProps(*, application_id, name, dimensions=None, segment_groups=None, tags=None)

Bases: object

Properties for defining a CfnSegment.

Parameters
  • application_id (str) – The unique identifier for the Amazon Pinpoint application that the segment is associated with.

  • name (str) – The name of the segment.

  • dimensions (Union[IResolvable, SegmentDimensionsProperty, None]) – The criteria that define the dimensions for the segment.

  • segment_groups (Union[IResolvable, SegmentGroupsProperty, None]) – The segment group to use and the dimensions to apply to the group’s base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

  • tags (Optional[Any]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Link

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

ExampleMetadata

fixture=_generated

Example:

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

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

cfn_segment_props = pinpoint.CfnSegmentProps(
    application_id="applicationId",
    name="name",

    # the properties below are optional
    dimensions=pinpoint.CfnSegment.SegmentDimensionsProperty(
        attributes=attributes,
        behavior=pinpoint.CfnSegment.BehaviorProperty(
            recency=pinpoint.CfnSegment.RecencyProperty(
                duration="duration",
                recency_type="recencyType"
            )
        ),
        demographic=pinpoint.CfnSegment.DemographicProperty(
            app_version=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            channel=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            device_type=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            make=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            model=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            platform=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            )
        ),
        location=pinpoint.CfnSegment.LocationProperty(
            country=pinpoint.CfnSegment.SetDimensionProperty(
                dimension_type="dimensionType",
                values=["values"]
            ),
            gps_point=pinpoint.CfnSegment.GPSPointProperty(
                coordinates=pinpoint.CfnSegment.CoordinatesProperty(
                    latitude=123,
                    longitude=123
                ),
                range_in_kilometers=123
            )
        ),
        metrics=metrics,
        user_attributes=user_attributes
    ),
    segment_groups=pinpoint.CfnSegment.SegmentGroupsProperty(
        groups=[pinpoint.CfnSegment.GroupsProperty(
            dimensions=[pinpoint.CfnSegment.SegmentDimensionsProperty(
                attributes=attributes,
                behavior=pinpoint.CfnSegment.BehaviorProperty(
                    recency=pinpoint.CfnSegment.RecencyProperty(
                        duration="duration",
                        recency_type="recencyType"
                    )
                ),
                demographic=pinpoint.CfnSegment.DemographicProperty(
                    app_version=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    channel=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    device_type=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    make=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    model=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    platform=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    )
                ),
                location=pinpoint.CfnSegment.LocationProperty(
                    country=pinpoint.CfnSegment.SetDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    gps_point=pinpoint.CfnSegment.GPSPointProperty(
                        coordinates=pinpoint.CfnSegment.CoordinatesProperty(
                            latitude=123,
                            longitude=123
                        ),
                        range_in_kilometers=123
                    )
                ),
                metrics=metrics,
                user_attributes=user_attributes
            )],
            source_segments=[pinpoint.CfnSegment.SourceSegmentsProperty(
                id="id",

                # the properties below are optional
                version=123
            )],
            source_type="sourceType",
            type="type"
        )],
        include="include"
    ),
    tags=tags
)

Attributes

application_id

The unique identifier for the Amazon Pinpoint application that the segment is associated with.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-applicationid

Return type

str

dimensions

The criteria that define the dimensions for the segment.

Link

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

Return type

Union[IResolvable, SegmentDimensionsProperty, None]

name

The name of the segment.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-name

Return type

str

segment_groups

The segment group to use and the dimensions to apply to the group’s base segments in order to build the segment.

A segment group can consist of zero or more base segments. Your request can include only one segment group.

Link

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

Return type

Union[IResolvable, SegmentGroupsProperty, None]

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-tags

Return type

Any