CfnSegmentDefinition

class aws_cdk.aws_customerprofiles.CfnSegmentDefinition(scope, id, *, display_name, domain_name, segment_definition_name, segment_groups, description=None, tags=None)

Bases: CfnResource

A segment definition resource of Amazon Connect Customer Profiles.

See:

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

CloudformationResource:

AWS::CustomerProfiles::SegmentDefinition

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 = customerprofiles.CfnSegmentDefinition(self, "MyCfnSegmentDefinition",
    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"
    )]
)

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

• 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str) –

• value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

• policy (Optional[RemovalPolicy]) –

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

• attribute_name (str) – The name of the attribute.

• type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CustomerProfiles::SegmentDefinition'

attr_created_at

When the segment definition was created.

CloudformationAttribute:

CreatedAt

attr_segment_definition_arn

The arn of the segment definition.

CloudformationAttribute:

SegmentDefinitionArn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the segment definition.

display_name

Display name of the segment definition.

domain_name

The name of the domain.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

segment_definition_name

Name of the segment definition.

segment_groups

Contains all groups of the segment definition.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

The tags belonging to the segment definition.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AddressDimensionProperty

class CfnSegmentDefinition.AddressDimensionProperty(*, city=None, country=None, county=None, postal_code=None, province=None, state=None)

Bases: object

Object 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.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

address_dimension_property = 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

city

The city belonging to the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-city

country

The country belonging to the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-country

county

The county belonging to the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-county

postal_code

The postal code belonging to the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode

province

The province belonging to the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-province

state

The state belonging to the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-state

AttributeDimensionProperty

class CfnSegmentDefinition.AttributeDimensionProperty(*, dimension_type, values)

Bases: object

Object that defines how to filter the incoming objects for the calculated attribute.

Parameters:

• dimension_type (str) – The action to segment with.

• values (Sequence[str]) – The values to apply the DimensionType on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.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

attribute_dimension_property = customerprofiles.CfnSegmentDefinition.AttributeDimensionProperty(
    dimension_type="dimensionType",
    values=["values"]
)

Attributes

dimension_type

The action to segment with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype

values

The values to apply the DimensionType on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-values

CalculatedAttributeDimensionProperty

class CfnSegmentDefinition.CalculatedAttributeDimensionProperty(*, dimension_type, values, condition_overrides=None)

Bases: object

Object that segments on Customer Profile’s Calculated Attributes.

Parameters:

• dimension_type (str) – The action to segment with.

• values (Sequence[str]) – The values to apply the DimensionType with.

• condition_overrides (Union[IResolvable, ConditionOverridesProperty, Dict[str, Any], None]) – Applies the given condition over the initial Calculated Attribute’s definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.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

calculated_attribute_dimension_property = 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
        )
    )
)

Attributes

condition_overrides

Applies the given condition over the initial Calculated Attribute’s definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides

dimension_type

The action to segment with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype

values

The values to apply the DimensionType with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values

ConditionOverridesProperty

class CfnSegmentDefinition.ConditionOverridesProperty(*, range=None)

Bases: object

An 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.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

condition_overrides_property = customerprofiles.CfnSegmentDefinition.ConditionOverridesProperty(
    range=customerprofiles.CfnSegmentDefinition.RangeOverrideProperty(
        start=123,
        unit="unit",

        # the properties below are optional
        end=123
    )
)

Attributes

range

The relative time period over which data is included in the aggregation for this override.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.html#cfn-customerprofiles-segmentdefinition-conditionoverrides-range

DateDimensionProperty

class CfnSegmentDefinition.DateDimensionProperty(*, dimension_type, values)

Bases: object

Object that segments on various Customer Profile’s date fields.

Parameters:

• dimension_type (str) – The action to segment on.

• values (Sequence[str]) – The values to apply the DimensionType on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.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

date_dimension_property = customerprofiles.CfnSegmentDefinition.DateDimensionProperty(
    dimension_type="dimensionType",
    values=["values"]
)

Attributes

dimension_type

The action to segment on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype

values

The values to apply the DimensionType on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-values

DimensionProperty

class CfnSegmentDefinition.DimensionProperty(*, calculated_attributes=None, profile_attributes=None)

Bases: object

Defines 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.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

dimension_property = 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"]
            )
        )
    )
)

Attributes

calculated_attributes

Object that holds the calculated attributes to segment on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes

profile_attributes

Object that holds the profile attributes to segment on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html#cfn-customerprofiles-segmentdefinition-dimension-profileattributes

ExtraLengthValueProfileDimensionProperty

class CfnSegmentDefinition.ExtraLengthValueProfileDimensionProperty(*, dimension_type, values)

Bases: object

Object that segments on various Customer profile’s fields that are larger than normal.

Parameters:

• dimension_type (str) – The action to segment with.

• values (Sequence[str]) – The values to apply the DimensionType on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.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

extra_length_value_profile_dimension_property = customerprofiles.CfnSegmentDefinition.ExtraLengthValueProfileDimensionProperty(
    dimension_type="dimensionType",
    values=["values"]
)

Attributes

dimension_type

The action to segment with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype

values

The values to apply the DimensionType on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values

GroupProperty

class CfnSegmentDefinition.GroupProperty(*, dimensions=None, source_segments=None, source_type=None, type=None)

Bases: object

Contains 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.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

group_property = 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"
)

Attributes

dimensions

Defines the attributes to segment on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-dimensions

source_segments

Defines the starting source of data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcesegments

source_type

Defines how to interact with the source data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcetype

type

Defines how to interact with the profiles found in the current filtering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-type

ProfileAttributesProperty

class CfnSegmentDefinition.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, shipping_address=None)

Bases: object

The 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.

• shipping_address (Union[IResolvable, AddressDimensionProperty, Dict[str, Any], None]) – A field to describe values to segment on within shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.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

profile_attributes_property = 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"]
        )
    )
)

Attributes

account_number

A field to describe values to segment on within account number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber

additional_information

A field to describe values to segment on within additional information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation

address

A field to describe values to segment on within address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-address

attributes

A field to describe values to segment on within attributes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-attributes

billing_address

A field to describe values to segment on within billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress

birth_date

A field to describe values to segment on within birthDate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate

business_email_address

A field to describe values to segment on within business email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress

business_name

A field to describe values to segment on within business name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessname

business_phone_number

A field to describe values to segment on within business phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber

email_address

A field to describe values to segment on within email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress

first_name

A field to describe values to segment on within first name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-firstname

gender_string

A field to describe values to segment on within genderString.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring

home_phone_number

A field to describe values to segment on within home phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber

last_name

A field to describe values to segment on within last name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-lastname

mailing_address

A field to describe values to segment on within mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress

middle_name

A field to describe values to segment on within middle name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-middlename

mobile_phone_number

A field to describe values to segment on within mobile phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber

party_type_string

A field to describe values to segment on within partyTypeString.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring

personal_email_address

A field to describe values to segment on within personal email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress

phone_number

A field to describe values to segment on within phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber

shipping_address

A field to describe values to segment on within shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress

ProfileDimensionProperty

class CfnSegmentDefinition.ProfileDimensionProperty(*, dimension_type, values)

Bases: object

Object that segments on various Customer profile’s fields that are larger than normal.

Parameters:

• dimension_type (str) – The action to segment on.

• values (Sequence[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.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

profile_dimension_property = customerprofiles.CfnSegmentDefinition.ProfileDimensionProperty(
    dimension_type="dimensionType",
    values=["values"]
)

Attributes

dimension_type

The action to segment on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-values

Type:

see

RangeOverrideProperty

class CfnSegmentDefinition.RangeOverrideProperty(*, start, unit, end=None)

Bases: object

Overrides the original range on a calculated attribute definition.

Parameters:

• start (Union[int, float]) – The start time of when to include objects.

• unit (str) – The unit for start and end.

• end (Union[int, float, None]) – The end time of when to include objects.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.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

range_override_property = customerprofiles.CfnSegmentDefinition.RangeOverrideProperty(
    start=123,
    unit="unit",

    # the properties below are optional
    end=123
)

Attributes

end

The end time of when to include objects.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-end

start

The start time of when to include objects.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-start

unit

The unit for start and end.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-unit

SegmentGroupProperty

class CfnSegmentDefinition.SegmentGroupProperty(*, groups=None, include=None)

Bases: object

Contains 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.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

segment_group_property = 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"
)

Attributes

groups

Holds the list of groups within the segment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-groups

include

Defines whether to include or exclude the profiles that fit the segment criteria.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-include

SourceSegmentProperty

class CfnSegmentDefinition.SourceSegmentProperty(*, segment_definition_name=None)

Bases: object

The source segments to build off of.

Parameters:

segment_definition_name (Optional[str]) – The name of the source segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sourcesegment.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

source_segment_property = customerprofiles.CfnSegmentDefinition.SourceSegmentProperty(
    segment_definition_name="segmentDefinitionName"
)

Attributes

segment_definition_name

The name of the source segment.

See:

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