class CfnSegmentPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Pinpoint.Mixins.CfnSegmentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspinpoint/mixins#CfnSegmentPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.pinpoint.mixins.CfnSegmentPropsMixin
Python	aws_cdk.mixins_preview.aws_pinpoint.mixins.CfnSegmentPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_pinpoint » mixins » CfnSegmentPropsMixin

Implements IMixin

Extends Mixin

Updates the configuration, dimension, and other settings for an existing segment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.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 pinpoint_mixins } from '@aws-cdk/mixins-preview/aws-pinpoint';

declare const attributes: any;
declare const metrics: any;
declare const tags: any;
declare const userAttributes: any;
const cfnSegmentPropsMixin = new pinpoint_mixins.CfnSegmentPropsMixin({
  applicationId: 'applicationId',
  dimensions: {
    attributes: attributes,
    behavior: {
      recency: {
        duration: 'duration',
        recencyType: 'recencyType',
      },
    },
    demographic: {
      appVersion: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
      channel: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
      deviceType: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
      make: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
      model: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
      platform: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
    },
    location: {
      country: {
        dimensionType: 'dimensionType',
        values: ['values'],
      },
      gpsPoint: {
        coordinates: {
          latitude: 123,
          longitude: 123,
        },
        rangeInKilometers: 123,
      },
    },
    metrics: metrics,
    userAttributes: userAttributes,
  },
  name: 'name',
  segmentGroups: {
    groups: [{
      dimensions: [{
        attributes: attributes,
        behavior: {
          recency: {
            duration: 'duration',
            recencyType: 'recencyType',
          },
        },
        demographic: {
          appVersion: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          channel: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          deviceType: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          make: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          model: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          platform: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
        },
        location: {
          country: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          gpsPoint: {
            coordinates: {
              latitude: 123,
              longitude: 123,
            },
            rangeInKilometers: 123,
          },
        },
        metrics: metrics,
        userAttributes: userAttributes,
      }],
      sourceSegments: [{
        id: 'id',
        version: 123,
      }],
      sourceType: 'sourceType',
      type: 'type',
    }],
    include: 'include',
  },
  tags: tags,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnSegmentPropsMixin(props: CfnSegmentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::Pinpoint::Segment.

Properties

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

---

props

Type: CfnSegmentMixinProps

---

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.