class CfnSegmentPropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Evidently.CfnSegmentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsevidently#CfnSegmentPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.evidently.CfnSegmentPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_evidently.CfnSegmentPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_evidently » CfnSegmentPropsMixin

Implements IMixin

Extends Mixin

Creates or updates a segment of your audience.

A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allow you to define different traffic splits for the different audience segments.

For more information about segment pattern syntax, see Segment rule pattern syntax .

The pattern that you define for a segment is matched against the value of evaluationContext , which is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a feature variation to a user.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_evidently as evidently } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnSegmentPropsMixin = new evidently.CfnSegmentPropsMixin({
  description: 'description',
  name: 'name',
  pattern: 'pattern',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

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::Evidently::Segment.

Properties

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

---

props

Type: CfnSegmentMixinProps

---

strategy

Type: IMergeStrategy

---

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): void

Parameters

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