aws-cdk-lib.aws_evidently.CfnLaunchProps

interface CfnLaunchProps

LanguageType name
.NETAmazon.CDK.AWS.Evidently.CfnLaunchProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevidently#CfnLaunchProps
Javasoftware.amazon.awscdk.services.evidently.CfnLaunchProps
Pythonaws_cdk.aws_evidently.CfnLaunchProps
TypeScript aws-cdk-lib » aws_evidently » CfnLaunchProps

Properties for defining a CfnLaunch.

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-lib';
const cfnLaunchProps: evidently.CfnLaunchProps = {
  groups: [{
    feature: 'feature',
    groupName: 'groupName',
    variation: 'variation',

    // the properties below are optional
    description: 'description',
  }],
  name: 'name',
  project: 'project',
  scheduledSplitsConfig: [{
    groupWeights: [{
      groupName: 'groupName',
      splitWeight: 123,
    }],
    startTime: 'startTime',

    // the properties below are optional
    segmentOverrides: [{
      evaluationOrder: 123,
      segment: 'segment',
      weights: [{
        groupName: 'groupName',
        splitWeight: 123,
      }],
    }],
  }],

  // the properties below are optional
  description: 'description',
  executionStatus: {
    status: 'status',

    // the properties below are optional
    desiredState: 'desiredState',
    reason: 'reason',
  },
  metricMonitors: [{
    entityIdKey: 'entityIdKey',
    metricName: 'metricName',
    valueKey: 'valueKey',

    // the properties below are optional
    eventPattern: 'eventPattern',
    unitLabel: 'unitLabel',
  }],
  randomizationSalt: 'randomizationSalt',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
groupsIResolvable | IResolvable | LaunchGroupObjectProperty[]An array of structures that contains the feature and variations that are to be used for the launch.
namestringThe name for the launch.
projectstringThe name or ARN of the project that you want to create the launch in.
scheduledSplitsConfigIResolvable | IResolvable | StepConfigProperty[]An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
description?stringAn optional description for the launch.
executionStatus?IResolvable | ExecutionStatusObjectPropertyA structure that you can use to start and stop the launch.
metricMonitors?IResolvable | IResolvable | MetricDefinitionObjectProperty[]An array of structures that define the metrics that will be used to monitor the launch performance.
randomizationSalt?stringWhen Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.
tags?CfnTag[]Assigns one or more tags (key-value pairs) to the launch.

groups

Type: IResolvable | IResolvable | LaunchGroupObjectProperty[]

An array of structures that contains the feature and variations that are to be used for the launch.

You can up to five launch groups in a launch.


name

Type: string

The name for the launch.

It can include up to 127 characters.


project

Type: string

The name or ARN of the project that you want to create the launch in.


scheduledSplitsConfig

Type: IResolvable | IResolvable | StepConfigProperty[]

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.


description?

Type: string (optional)

An optional description for the launch.


executionStatus?

Type: IResolvable | ExecutionStatusObjectProperty (optional)

A structure that you can use to start and stop the launch.


metricMonitors?

Type: IResolvable | IResolvable | MetricDefinitionObjectProperty[] (optional)

An array of structures that define the metrics that will be used to monitor the launch performance.

You can have up to three metric monitors in the array.


randomizationSalt?

Type: string (optional)

When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.

This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .


tags?

Type: CfnTag[] (optional)

Assigns one or more tags (key-value pairs) to the launch.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a launch.

For more information, see Tagging AWS resources .