CfnSegmentDefinitionPropsMixin
- class aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnSegmentDefinitionPropsMixin(props, *, strategy=None)
Bases:
MixinA segment definition resource of Amazon Connect Customer Profiles.
- See:
- CloudformationResource:
AWS::CustomerProfiles::SegmentDefinition
- 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_customerprofiles import mixins as customerprofiles_mixins cfn_segment_definition_props_mixin = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin(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" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::CustomerProfiles::SegmentDefinition.- Parameters:
props (
Union[CfnSegmentDefinitionMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['description', 'displayName', 'domainName', 'segmentDefinitionName', 'segmentGroups', 'segmentSqlQuery', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AddressDimensionProperty
- class CfnSegmentDefinitionPropsMixin.AddressDimensionProperty(*, city=None, country=None, county=None, postal_code=None, province=None, state=None)
Bases:
objectObject that segments on Customer Profile’s address object.
- Parameters:
city (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – The city belonging to the address.country (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – The country belonging to the address.county (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – The county belonging to the address.postal_code (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – The postal code belonging to the address.province (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – The province belonging to the address.state (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – The state belonging to the address.
- See:
- 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 address_dimension_property = 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
- city
The city belonging to the address.
- country
The country belonging to the address.
- county
The county belonging to the address.
- postal_code
The postal code belonging to the address.
- province
The province belonging to the address.
AttributeDimensionProperty
- class CfnSegmentDefinitionPropsMixin.AttributeDimensionProperty(*, dimension_type=None, values=None)
Bases:
objectObject that defines how to filter the incoming objects for the calculated attribute.
- Parameters:
dimension_type (
Optional[str]) – The action to segment with.values (
Optional[Sequence[str]]) – The values to apply the DimensionType on.
- See:
- 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 attribute_dimension_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.AttributeDimensionProperty( dimension_type="dimensionType", values=["values"] )
Attributes
- dimension_type
The action to segment with.
- values
The values to apply the DimensionType on.
CalculatedAttributeDimensionProperty
- class CfnSegmentDefinitionPropsMixin.CalculatedAttributeDimensionProperty(*, condition_overrides=None, dimension_type=None, values=None)
Bases:
objectObject that segments on Customer Profile’s Calculated Attributes.
- Parameters:
condition_overrides (
Union[IResolvable,ConditionOverridesProperty,Dict[str,Any],None]) – Applies the given condition over the initial Calculated Attribute’s definition.dimension_type (
Optional[str]) – The action to segment with.values (
Optional[Sequence[str]]) – The values to apply the DimensionType with.
- See:
- 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 calculated_attribute_dimension_property = 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"] )
Attributes
- condition_overrides
Applies the given condition over the initial Calculated Attribute’s definition.
- dimension_type
The action to segment with.
- values
The values to apply the DimensionType with.
ConditionOverridesProperty
- class CfnSegmentDefinitionPropsMixin.ConditionOverridesProperty(*, range=None)
Bases:
objectAn object to override the original condition block of a calculated attribute.
- Parameters:
range (
Union[IResolvable,RangeOverrideProperty,Dict[str,Any],None]) – The relative time period over which data is included in the aggregation for this override.- See:
- 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 condition_overrides_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ConditionOverridesProperty( range=customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.RangeOverrideProperty( end=123, start=123, unit="unit" ) )
Attributes
- range
The relative time period over which data is included in the aggregation for this override.
DateDimensionProperty
- class CfnSegmentDefinitionPropsMixin.DateDimensionProperty(*, dimension_type=None, values=None)
Bases:
objectObject that segments on various Customer Profile’s date fields.
- Parameters:
dimension_type (
Optional[str]) – The action to segment on.values (
Optional[Sequence[str]]) – The values to apply the DimensionType on.
- See:
- 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 date_dimension_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.DateDimensionProperty( dimension_type="dimensionType", values=["values"] )
Attributes
- dimension_type
The action to segment on.
- values
The values to apply the DimensionType on.
DimensionProperty
- class CfnSegmentDefinitionPropsMixin.DimensionProperty(*, calculated_attributes=None, profile_attributes=None)
Bases:
objectDefines the attribute to segment on.
- Parameters:
calculated_attributes (
Union[IResolvable,Mapping[str,Union[IResolvable,CalculatedAttributeDimensionProperty,Dict[str,Any]]],None]) – Object that holds the calculated attributes to segment on.profile_attributes (
Union[IResolvable,ProfileAttributesProperty,Dict[str,Any],None]) – Object that holds the profile attributes to segment on.
- See:
- 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 dimension_property = 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"] ) ) ) )
Attributes
- calculated_attributes
Object that holds the calculated attributes to segment on.
- profile_attributes
Object that holds the profile attributes to segment on.
ExtraLengthValueProfileDimensionProperty
- class CfnSegmentDefinitionPropsMixin.ExtraLengthValueProfileDimensionProperty(*, dimension_type=None, values=None)
Bases:
objectObject that segments on various Customer profile’s fields that are larger than normal.
- Parameters:
dimension_type (
Optional[str]) – The action to segment with.values (
Optional[Sequence[str]]) – The values to apply the DimensionType on.
- See:
- 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 extra_length_value_profile_dimension_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ExtraLengthValueProfileDimensionProperty( dimension_type="dimensionType", values=["values"] )
Attributes
- dimension_type
The action to segment with.
GroupProperty
- class CfnSegmentDefinitionPropsMixin.GroupProperty(*, dimensions=None, source_segments=None, source_type=None, type=None)
Bases:
objectContains dimensions that determine what to segment on.
- Parameters:
dimensions (
Union[IResolvable,Sequence[Union[IResolvable,DimensionProperty,Dict[str,Any]]],None]) – Defines the attributes to segment on.source_segments (
Union[IResolvable,Sequence[Union[IResolvable,SourceSegmentProperty,Dict[str,Any]]],None]) – Defines the starting source of data.source_type (
Optional[str]) – Defines how to interact with the source data.type (
Optional[str]) – Defines how to interact with the profiles found in the current filtering.
- See:
- 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 group_property = 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" )
Attributes
- dimensions
Defines the attributes to segment on.
- source_segments
Defines the starting source of data.
- source_type
Defines how to interact with the source data.
- type
Defines how to interact with the profiles found in the current filtering.
ProfileAttributesProperty
- class CfnSegmentDefinitionPropsMixin.ProfileAttributesProperty(*, account_number=None, additional_information=None, address=None, attributes=None, billing_address=None, birth_date=None, business_email_address=None, business_name=None, business_phone_number=None, email_address=None, first_name=None, gender_string=None, home_phone_number=None, last_name=None, mailing_address=None, middle_name=None, mobile_phone_number=None, party_type_string=None, personal_email_address=None, phone_number=None, profile_type=None, shipping_address=None)
Bases:
objectThe object used to segment on attributes within the customer profile.
- Parameters:
account_number (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within account number.additional_information (
Union[IResolvable,ExtraLengthValueProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within additional information.address (
Union[IResolvable,AddressDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within address.attributes (
Union[IResolvable,Mapping[str,Union[IResolvable,AttributeDimensionProperty,Dict[str,Any]]],None]) – A field to describe values to segment on within attributes.billing_address (
Union[IResolvable,AddressDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within billing address.birth_date (
Union[IResolvable,DateDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within birthDate.business_email_address (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within business email address.business_name (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within business name.business_phone_number (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within business phone number.email_address (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within email address.first_name (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within first name.gender_string (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within genderString.home_phone_number (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within home phone number.last_name (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within last name.mailing_address (
Union[IResolvable,AddressDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within mailing address.middle_name (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within middle name.mobile_phone_number (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within mobile phone number.party_type_string (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within partyTypeString.personal_email_address (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within personal email address.phone_number (
Union[IResolvable,ProfileDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within phone number.profile_type (
Union[IResolvable,ProfileTypeDimensionProperty,Dict[str,Any],None]) – The type of profile.shipping_address (
Union[IResolvable,AddressDimensionProperty,Dict[str,Any],None]) – A field to describe values to segment on within shipping address.
- See:
- 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 profile_attributes_property = 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"] ) ) )
Attributes
- account_number
A field to describe values to segment on within account number.
- additional_information
A field to describe values to segment on within additional information.
- address
A field to describe values to segment on within address.
- attributes
A field to describe values to segment on within attributes.
- billing_address
A field to describe values to segment on within billing address.
- birth_date
A field to describe values to segment on within birthDate.
- business_email_address
A field to describe values to segment on within business email address.
- business_name
A field to describe values to segment on within business name.
- business_phone_number
A field to describe values to segment on within business phone number.
- email_address
A field to describe values to segment on within email address.
- first_name
A field to describe values to segment on within first name.
- gender_string
A field to describe values to segment on within genderString.
- home_phone_number
A field to describe values to segment on within home phone number.
- last_name
A field to describe values to segment on within last name.
- mailing_address
A field to describe values to segment on within mailing address.
- middle_name
A field to describe values to segment on within middle name.
- mobile_phone_number
A field to describe values to segment on within mobile phone number.
- party_type_string
A field to describe values to segment on within partyTypeString.
- personal_email_address
A field to describe values to segment on within personal email address.
- phone_number
A field to describe values to segment on within phone number.
- profile_type
The type of profile.
- shipping_address
A field to describe values to segment on within shipping address.
ProfileDimensionProperty
- class CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty(*, dimension_type=None, values=None)
Bases:
objectObject that segments on various Customer profile’s fields that are larger than normal.
- Parameters:
dimension_type (
Optional[str]) – The action to segment on.values (
Optional[Sequence[str]])
- See:
- 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 profile_dimension_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] )
Attributes
- dimension_type
The action to segment on.
ProfileTypeDimensionProperty
- class CfnSegmentDefinitionPropsMixin.ProfileTypeDimensionProperty(*, dimension_type=None, values=None)
Bases:
objectSpecifies profile type based criteria for a segment.
- Parameters:
dimension_type (
Optional[str]) – The action to segment on.values (
Optional[Sequence[str]]) – The values to apply the DimensionType on.
- See:
- 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 profile_type_dimension_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.ProfileTypeDimensionProperty( dimension_type="dimensionType", values=["values"] )
Attributes
- dimension_type
The action to segment on.
- values
The values to apply the DimensionType on.
RangeOverrideProperty
- class CfnSegmentDefinitionPropsMixin.RangeOverrideProperty(*, end=None, start=None, unit=None)
Bases:
objectOverrides the original range on a calculated attribute definition.
- Parameters:
end (
Union[int,float,None]) – The end time of when to include objects.start (
Union[int,float,None]) – The start time of when to include objects.unit (
Optional[str]) – The unit for start and end.
- See:
- 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 range_override_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.RangeOverrideProperty( end=123, start=123, unit="unit" )
Attributes
- end
The end time of when to include objects.
- start
The start time of when to include objects.
SegmentGroupProperty
- class CfnSegmentDefinitionPropsMixin.SegmentGroupProperty(*, groups=None, include=None)
Bases:
objectContains all groups of the segment definition.
- Parameters:
groups (
Union[IResolvable,Sequence[Union[IResolvable,GroupProperty,Dict[str,Any]]],None]) – Holds the list of groups within the segment definition.include (
Optional[str]) – Defines whether to include or exclude the profiles that fit the segment criteria.
- See:
- 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 segment_group_property = 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" )
Attributes
- groups
Holds the list of groups within the segment definition.
- include
Defines whether to include or exclude the profiles that fit the segment criteria.
SourceSegmentProperty
- class CfnSegmentDefinitionPropsMixin.SourceSegmentProperty(*, segment_definition_name=None)
Bases:
objectThe source segments to build off of.
- Parameters:
segment_definition_name (
Optional[str]) – The name of the source segment.- See:
- 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 source_segment_property = customerprofiles_mixins.CfnSegmentDefinitionPropsMixin.SourceSegmentProperty( segment_definition_name="segmentDefinitionName" )
Attributes
- segment_definition_name
The name of the source segment.