interface CfnSegmentDefinitionMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CustomerProfiles.Mixins.CfnSegmentDefinitionMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscustomerprofiles/mixins#CfnSegmentDefinitionMixinProps
Java	software.amazon.awscdk.mixins.preview.services.customerprofiles.mixins.CfnSegmentDefinitionMixinProps
Python	aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnSegmentDefinitionMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_customerprofiles » mixins » CfnSegmentDefinitionMixinProps

Properties for CfnSegmentDefinitionPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as customerprofiles_mixins } from '@aws-cdk/mixins-preview/aws-customerprofiles';
const cfnSegmentDefinitionMixinProps: customerprofiles_mixins.CfnSegmentDefinitionMixinProps = {
  description: 'description',
  displayName: 'displayName',
  domainName: 'domainName',
  segmentDefinitionName: 'segmentDefinitionName',
  segmentGroups: {
    groups: [{
      dimensions: [{
        calculatedAttributes: {
          calculatedAttributesKey: {
            conditionOverrides: {
              range: {
                end: 123,
                start: 123,
                unit: 'unit',
              },
            },
            dimensionType: 'dimensionType',
            values: ['values'],
          },
        },
        profileAttributes: {
          accountNumber: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          additionalInformation: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          address: {
            city: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            country: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            county: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            postalCode: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            province: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            state: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
          },
          attributes: {
            attributesKey: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
          },
          billingAddress: {
            city: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            country: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            county: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            postalCode: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            province: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            state: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
          },
          birthDate: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          businessEmailAddress: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          businessName: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          businessPhoneNumber: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          emailAddress: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          firstName: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          genderString: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          homePhoneNumber: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          lastName: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          mailingAddress: {
            city: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            country: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            county: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            postalCode: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            province: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            state: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
          },
          middleName: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          mobilePhoneNumber: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          partyTypeString: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          personalEmailAddress: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          phoneNumber: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          profileType: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          shippingAddress: {
            city: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            country: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            county: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            postalCode: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            province: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
            state: {
              dimensionType: 'dimensionType',
              values: ['values'],
            },
          },
        },
      }],
      sourceSegments: [{
        segmentDefinitionName: 'segmentDefinitionName',
      }],
      sourceType: 'sourceType',
      type: 'type',
    }],
    include: 'include',
  },
  segmentSqlQuery: 'segmentSqlQuery',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
description?	string	The description of the segment definition.
displayName?	string	Display name of the segment definition.
domainName?	string	The name of the domain.
segmentDefinitionName?	string	Name of the segment definition.
segmentGroups?	IResolvable | SegmentGroupProperty	Contains all groups of the segment definition.
segmentSqlQuery?	string	The SQL query that defines the segment criteria.
tags?	CfnTag[]	The tags belonging to the segment definition.

---

description?

Type: string (optional)

The description of the segment definition.

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

---

displayName?

Type: string (optional)

Display name of the segment definition.

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

---

domainName?

Type: string (optional)

The name of the domain.

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

---

segmentDefinitionName?

Type: string (optional)

Name of the segment definition.

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

---

segmentGroups?

Type: IResolvable | SegmentGroupProperty (optional)

Contains all groups of the segment definition.

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

---

segmentSqlQuery?

Type: string (optional)

The SQL query that defines the segment criteria.

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

---

tags?

Type: CfnTag[] (optional)

The tags belonging to the segment definition.

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