class CfnSegmentDefinitionPropsMixin

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

Implements IMixin

Extends Mixin

A segment definition resource of Amazon Connect Customer Profiles.

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 } from '@aws-cdk/mixins-preview';
import { mixins as customerprofiles_mixins } from '@aws-cdk/mixins-preview/aws-customerprofiles';
const cfnSegmentDefinitionPropsMixin = new customerprofiles_mixins.CfnSegmentDefinitionPropsMixin({
  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',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnSegmentDefinitionPropsMixin(props: CfnSegmentDefinitionMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnSegmentDefinitionMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CustomerProfiles::SegmentDefinition.

Properties

Name	Type	Description
props	CfnSegmentDefinitionMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnSegmentDefinitionMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.