CfnSegmentDefinitionMixinProps
- class aws_cdk.cfn_property_mixins.aws_customerprofiles.CfnSegmentDefinitionMixinProps(*, description=None, display_name=None, domain_name=None, segment_definition_name=None, segment_groups=None, segment_sql_query=None, tags=None)
Bases:
objectProperties 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:
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles cfn_segment_definition_mixin_props = customerprofiles.CfnSegmentDefinitionMixinProps( description="description", display_name="displayName", domain_name="domainName", segment_definition_name="segmentDefinitionName", segment_groups=customerprofiles.CfnSegmentDefinitionPropsMixin.SegmentGroupProperty( groups=[customerprofiles.CfnSegmentDefinitionPropsMixin.GroupProperty( dimensions=[customerprofiles.CfnSegmentDefinitionPropsMixin.DimensionProperty( calculated_attributes={ "calculated_attributes_key": customerprofiles.CfnSegmentDefinitionPropsMixin.CalculatedAttributeDimensionProperty( condition_overrides=customerprofiles.CfnSegmentDefinitionPropsMixin.ConditionOverridesProperty( range=customerprofiles.CfnSegmentDefinitionPropsMixin.RangeOverrideProperty( end=123, start=123, unit="unit" ) ), dimension_type="dimensionType", values=["values"] ) }, profile_attributes=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileAttributesProperty( account_number=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), additional_information=customerprofiles.CfnSegmentDefinitionPropsMixin.ExtraLengthValueProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), address=customerprofiles.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty( city=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), country=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), county=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), postal_code=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), province=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), state=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ) ), attributes={ "attributes_key": customerprofiles.CfnSegmentDefinitionPropsMixin.AttributeDimensionProperty( dimension_type="dimensionType", values=["values"] ) }, billing_address=customerprofiles.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty( city=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), country=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), county=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), postal_code=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), province=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), state=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ) ), birth_date=customerprofiles.CfnSegmentDefinitionPropsMixin.DateDimensionProperty( dimension_type="dimensionType", values=["values"] ), business_email_address=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), business_name=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), business_phone_number=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), email_address=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), first_name=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), gender_string=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), home_phone_number=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), last_name=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), mailing_address=customerprofiles.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty( city=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), country=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), county=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), postal_code=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), province=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), state=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ) ), middle_name=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), mobile_phone_number=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), party_type_string=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), personal_email_address=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), phone_number=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), profile_type=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileTypeDimensionProperty( dimension_type="dimensionType", values=["values"] ), shipping_address=customerprofiles.CfnSegmentDefinitionPropsMixin.AddressDimensionProperty( city=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), country=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), county=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), postal_code=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), province=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ), state=customerprofiles.CfnSegmentDefinitionPropsMixin.ProfileDimensionProperty( dimension_type="dimensionType", values=["values"] ) ) ) )], source_segments=[customerprofiles.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.
- display_name
Display name of the segment definition.
- domain_name
The name of the domain.
- segment_definition_name
Name of the segment definition.
- segment_groups
Contains all groups of the segment definition.
- segment_sql_query
The SQL query that defines the segment criteria.
- tags
The tags belonging to the segment definition.