CfnSegmentDefinitionProps

class aws_cdk.aws_customerprofiles.CfnSegmentDefinitionProps(*, display_name, domain_name, segment_definition_name, segment_groups, description=None, tags=None)

Bases: object

Properties for defining a CfnSegmentDefinition.

Parameters:

display_name (str) – Display name of the segment definition.
domain_name (str) – The name of the domain.
segment_definition_name (str) – Name of the segment definition.
segment_groups (Union[IResolvable, SegmentGroupProperty, Dict[str, Any]]) – Contains all groups of the segment definition.
description (Optional[str]) – The description of the segment definition.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags belonging to the segment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.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 import aws_customerprofiles as customerprofiles

cfn_segment_definition_props = customerprofiles.CfnSegmentDefinitionProps(
    display_name="displayName",
    domain_name="domainName",
    segment_definition_name="segmentDefinitionName",
    segment_groups=customerprofiles.CfnSegmentDefinition.SegmentGroupProperty(
        groups=[customerprofiles.CfnSegmentDefinition.GroupProperty(
            dimensions=[customerprofiles.CfnSegmentDefinition.DimensionProperty(
                calculated_attributes={
                    "calculated_attributes_key": customerprofiles.CfnSegmentDefinition.CalculatedAttributeDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"],

                        # the properties below are optional
                        condition_overrides=customerprofiles.CfnSegmentDefinition.ConditionOverridesProperty(
                            range=customerprofiles.CfnSegmentDefinition.RangeOverrideProperty(
                                start=123,
                                unit="unit",

                                # the properties below are optional
                                end=123
                            )
                        )
                    )
                },
                profile_attributes=customerprofiles.CfnSegmentDefinition.ProfileAttributesProperty(
                    account_number=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    additional_information=customerprofiles.CfnSegmentDefinition.ExtraLengthValueProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    address=customerprofiles.CfnSegmentDefinition.AddressDimensionProperty(
                        city=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    ),
                    attributes={
                        "attributes_key": customerprofiles.CfnSegmentDefinition.AttributeDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    },
                    billing_address=customerprofiles.CfnSegmentDefinition.AddressDimensionProperty(
                        city=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    ),
                    birth_date=customerprofiles.CfnSegmentDefinition.DateDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    business_email_address=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    business_name=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    business_phone_number=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    email_address=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    first_name=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    gender_string=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    home_phone_number=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    last_name=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    mailing_address=customerprofiles.CfnSegmentDefinition.AddressDimensionProperty(
                        city=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    ),
                    middle_name=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    mobile_phone_number=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    party_type_string=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    personal_email_address=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    phone_number=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    shipping_address=customerprofiles.CfnSegmentDefinition.AddressDimensionProperty(
                        city=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    )
                )
            )],
            source_segments=[customerprofiles.CfnSegmentDefinition.SourceSegmentProperty(
                segment_definition_name="segmentDefinitionName"
            )],
            source_type="sourceType",
            type="type"
        )],
        include="include"
    ),

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)