interface CfnSegmentDefinitionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CustomerProfiles.CfnSegmentDefinitionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnSegmentDefinitionProps |
![]() | software.amazon.awscdk.services.customerprofiles.CfnSegmentDefinitionProps |
![]() | aws_cdk.aws_customerprofiles.CfnSegmentDefinitionProps |
![]() | aws-cdk-lib » aws_customerprofiles » CfnSegmentDefinitionProps |
Properties for defining a CfnSegmentDefinition
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const cfnSegmentDefinitionProps: customerprofiles.CfnSegmentDefinitionProps = {
displayName: 'displayName',
domainName: 'domainName',
segmentDefinitionName: 'segmentDefinitionName',
segmentGroups: {
groups: [{
dimensions: [{
calculatedAttributes: {
calculatedAttributesKey: {
dimensionType: 'dimensionType',
values: ['values'],
// the properties below are optional
conditionOverrides: {
range: {
start: 123,
unit: 'unit',
// the properties below are optional
end: 123,
},
},
},
},
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'],
},
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',
},
// the properties below are optional
description: 'description',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
display | string | Display name of the segment definition. |
domain | string | The name of the domain. |
segment | string | Name of the segment definition. |
segment | IResolvable | Segment | Contains all groups of the segment definition. |
description? | string | The description of the segment definition. |
tags? | Cfn [] | The tags belonging to the segment definition. |
displayName
Type:
string
Display name of the segment definition.
domainName
Type:
string
The name of the domain.
segmentDefinitionName
Type:
string
Name of the segment definition.
segmentGroups
Type:
IResolvable
|
Segment
Contains all groups of the segment definition.
description?
Type:
string
(optional)
The description of the segment definition.
tags?
Type:
Cfn
[]
(optional)
The tags belonging to the segment definition.