CfnSegmentDefinitionMixinProps

class aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnSegmentDefinitionMixinProps(*, description=None, display_name=None, domain_name=None, segment_definition_name=None, segment_groups=None, segment_sql_query=None, tags=None)

Bases: object

Properties for CfnSegmentDefinitionPropsMixin.

Parameters:
  • description (Optional[str]) – The description of the segment definition.

  • display_name (Optional[str]) – Display name of the segment definition.

  • domain_name (Optional[str]) – The name of the domain.

  • segment_definition_name (Optional[str]) – Name of the segment definition.

  • segment_groups (Union[IResolvable, SegmentGroupProperty, Dict[str, Any], None]) – Contains all groups of the segment definition.

  • segment_sql_query (Optional[str]) – The SQL query that defines the segment criteria.

  • 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.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

cfn_segment_definition_mixin_props = customerprofiles_mixins.CfnSegmentDefinitionMixinProps(
    description="description",
    display_name="displayName",
    domain_name="domainName",
    segment_definition_name="segmentDefinitionName",
    segment_groups=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.SegmentGroupProperty(
        groups=[customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.GroupProperty(
            dimensions=[customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.DimensionProperty(
                calculated_attributes={
                    "calculated_attributes_key": customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.CalculatedAttributeDimensionProperty(
                        condition_overrides=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ConditionOverridesProperty(
                            range=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.RangeOverrideProperty(
                                end=123,
                                start=123,
                                unit="unit"
                            )
                        ),
                        dimension_type="dimensionType",
                        values=["values"]
                    )
                },
                profile_attributes=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileAttributesProperty(
                    account_number=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    additional_information=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ExtraLengthValueProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty(
                        city=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    ),
                    attributes={
                        "attributes_key": customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.AttributeDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    },
                    billing_address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty(
                        city=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    ),
                    birth_date=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.DateDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    business_email_address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    business_name=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    business_phone_number=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    email_address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    first_name=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    gender_string=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    home_phone_number=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    last_name=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    mailing_address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty(
                        city=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    ),
                    middle_name=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    mobile_phone_number=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    party_type_string=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    personal_email_address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    phone_number=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    profile_type=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileTypeDimensionProperty(
                        dimension_type="dimensionType",
                        values=["values"]
                    ),
                    shipping_address=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty(
                        city=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        country=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        county=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        postal_code=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        province=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        ),
                        state=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(
                            dimension_type="dimensionType",
                            values=["values"]
                        )
                    )
                )
            )],
            source_segments=[customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.SourceSegmentProperty(
                segment_definition_name="segmentDefinitionName"
            )],
            source_type="sourceType",
            type="type"
        )],
        include="include"
    ),
    segment_sql_query="segmentSqlQuery",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the segment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-description

display_name

Display name of the segment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-displayname

domain_name

The name of the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-domainname

segment_definition_name

Name of the segment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentdefinitionname

segment_groups

Contains all groups of the segment definition.

See:

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

segment_sql_query

The SQL query that defines the segment criteria.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentsqlquery

tags

The tags belonging to the segment definition.

See:

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