CfnLaunchPropsMixin

class aws_cdk.mixins_preview.aws_evidently.mixins.CfnLaunchPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates or updates a launch of a given feature.

Before you create a launch, you must create the feature to use for the launch.

You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html
CloudformationResource:: AWS::Evidently::Launch
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

cfn_launch_props_mixin = evidently_mixins.CfnLaunchPropsMixin(evidently_mixins.CfnLaunchMixinProps(
    description="description",
    execution_status=evidently_mixins.CfnLaunchPropsMixin.ExecutionStatusObjectProperty(
        desired_state="desiredState",
        reason="reason",
        status="status"
    ),
    groups=[evidently_mixins.CfnLaunchPropsMixin.LaunchGroupObjectProperty(
        description="description",
        feature="feature",
        group_name="groupName",
        variation="variation"
    )],
    metric_monitors=[evidently_mixins.CfnLaunchPropsMixin.MetricDefinitionObjectProperty(
        entity_id_key="entityIdKey",
        event_pattern="eventPattern",
        metric_name="metricName",
        unit_label="unitLabel",
        value_key="valueKey"
    )],
    name="name",
    project="project",
    randomization_salt="randomizationSalt",
    scheduled_splits_config=[evidently_mixins.CfnLaunchPropsMixin.StepConfigProperty(
        group_weights=[evidently_mixins.CfnLaunchPropsMixin.GroupToWeightProperty(
            group_name="groupName",
            split_weight=123
        )],
        segment_overrides=[evidently_mixins.CfnLaunchPropsMixin.SegmentOverrideProperty(
            evaluation_order=123,
            segment="segment",
            weights=[evidently_mixins.CfnLaunchPropsMixin.GroupToWeightProperty(
                group_name="groupName",
                split_weight=123
            )]
        )],
        start_time="startTime"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Evidently::Launch.

Parameters:

props (Union[CfnLaunchMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'executionStatus', 'groups', 'metricMonitors', 'name', 'project', 'randomizationSalt', 'scheduledSplitsConfig', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ExecutionStatusObjectProperty

class CfnLaunchPropsMixin.ExecutionStatusObjectProperty(*, desired_state=None, reason=None, status=None)

Bases: object

Use this structure to start and stop the launch.

Parameters:

desired_state (Optional[str]) – If you are using CloudFormation to stop this launch, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment. If you omit this parameter, the default of COMPLETED is used.
reason (Optional[str]) – If you are using CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled.
status (Optional[str]) – To start the launch now, specify START for this parameter. If this launch is currently running and you want to stop it now, specify STOP .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

execution_status_object_property = evidently_mixins.CfnLaunchPropsMixin.ExecutionStatusObjectProperty(
    desired_state="desiredState",
    reason="reason",
    status="status"
)

Attributes

desired_state

If you are using CloudFormation to stop this launch, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment.

If you omit this parameter, the default of COMPLETED is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-desiredstate

reason

If you are using CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-reason

status

To start the launch now, specify START for this parameter.

If this launch is currently running and you want to stop it now, specify STOP .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-status

GroupToWeightProperty

class CfnLaunchPropsMixin.GroupToWeightProperty(*, group_name=None, split_weight=None)

Bases: object

A structure containing the percentage of launch traffic to allocate to one launch group.

Parameters:

group_name (Optional[str]) – The name of the launch group. It can include up to 127 characters.
split_weight (Union[int, float, None]) – The portion of launch traffic to allocate to this launch group. This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

group_to_weight_property = evidently_mixins.CfnLaunchPropsMixin.GroupToWeightProperty(
    group_name="groupName",
    split_weight=123
)

Attributes

group_name

The name of the launch group.

It can include up to 127 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html#cfn-evidently-launch-grouptoweight-groupname

split_weight

The portion of launch traffic to allocate to this launch group.

This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html#cfn-evidently-launch-grouptoweight-splitweight

LaunchGroupObjectProperty

class CfnLaunchPropsMixin.LaunchGroupObjectProperty(*, description=None, feature=None, group_name=None, variation=None)

Bases: object

A structure that defines one launch group in a launch.

A launch group is a variation of the feature that you are including in the launch.

Parameters:

description (Optional[str]) – A description of the launch group.
feature (Optional[str]) – The feature that this launch is using.
group_name (Optional[str]) – A name for this launch group. It can include up to 127 characters.
variation (Optional[str]) – The feature variation to use for this launch group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

launch_group_object_property = evidently_mixins.CfnLaunchPropsMixin.LaunchGroupObjectProperty(
    description="description",
    feature="feature",
    group_name="groupName",
    variation="variation"
)

Attributes

description

A description of the launch group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-description

feature

The feature that this launch is using.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-feature

group_name

A name for this launch group.

It can include up to 127 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-groupname

variation

The feature variation to use for this launch group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-variation

MetricDefinitionObjectProperty

class CfnLaunchPropsMixin.MetricDefinitionObjectProperty(*, entity_id_key=None, event_pattern=None, metric_name=None, unit_label=None, value_key=None)

Bases: object

This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.

Parameters:

entity_id_key (Optional[str]) – The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID .
event_pattern (Optional[str]) – The EventBridge event pattern that defines how the metric is recorded. For more information about EventBridge event patterns, see Amazon EventBridge event patterns .
metric_name (Optional[str]) – A name for the metric. It can include up to 255 characters.
unit_label (Optional[str]) – A label for the units that the metric is measuring.
value_key (Optional[str]) – The value that is tracked to produce the metric.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

metric_definition_object_property = evidently_mixins.CfnLaunchPropsMixin.MetricDefinitionObjectProperty(
    entity_id_key="entityIdKey",
    event_pattern="eventPattern",
    metric_name="metricName",
    unit_label="unitLabel",
    value_key="valueKey"
)

Attributes

entity_id_key

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

An example is userDetails.userID .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-entityidkey

event_pattern

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-eventpattern

metric_name

A name for the metric.

It can include up to 255 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-metricname

unit_label

A label for the units that the metric is measuring.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-unitlabel

value_key

The value that is tracked to produce the metric.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-valuekey

SegmentOverrideProperty

class CfnLaunchPropsMixin.SegmentOverrideProperty(*, evaluation_order=None, segment=None, weights=None)

Bases: object

Use this structure to specify different traffic splits for one or more audience segments .

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.

For more information, see Use segments to focus your audience .

This sructure is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

Parameters:

evaluation_order (Union[int, float, None]) – A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
segment (Optional[str]) – The ARN of the segment to use for this override.
weights (Union[IResolvable, Sequence[Union[IResolvable, GroupToWeightProperty, Dict[str, Any]]], None]) – The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

segment_override_property = evidently_mixins.CfnLaunchPropsMixin.SegmentOverrideProperty(
    evaluation_order=123,
    segment="segment",
    weights=[evidently_mixins.CfnLaunchPropsMixin.GroupToWeightProperty(
        group_name="groupName",
        split_weight=123
    )]
)

Attributes

evaluation_order

A number indicating the order to use to evaluate segment overrides, if there are more than one.

Segment overrides with lower numbers are evaluated first.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-evaluationorder

segment

The ARN of the segment to use for this override.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-segment

weights

The traffic allocation percentages among the feature variations to assign to this segment.

This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-weights

StepConfigProperty

class CfnLaunchPropsMixin.StepConfigProperty(*, group_weights=None, segment_overrides=None, start_time=None)

Bases: object

A structure that defines when each step of the launch is to start, and how much launch traffic is to be allocated to each variation during each step.

Parameters:

group_weights (Union[IResolvable, Sequence[Union[IResolvable, GroupToWeightProperty, Dict[str, Any]]], None]) – An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
segment_overrides (Union[IResolvable, Sequence[Union[IResolvable, SegmentOverrideProperty, Dict[str, Any]]], None]) –
An array of structures that you can use to specify different traffic splits for one or more audience segments . 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. For more information, see Use segments to focus your audience .
start_time (Optional[str]) – The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

step_config_property = evidently_mixins.CfnLaunchPropsMixin.StepConfigProperty(
    group_weights=[evidently_mixins.CfnLaunchPropsMixin.GroupToWeightProperty(
        group_name="groupName",
        split_weight=123
    )],
    segment_overrides=[evidently_mixins.CfnLaunchPropsMixin.SegmentOverrideProperty(
        evaluation_order=123,
        segment="segment",
        weights=[evidently_mixins.CfnLaunchPropsMixin.GroupToWeightProperty(
            group_name="groupName",
            split_weight=123
        )]
    )],
    start_time="startTime"
)

Attributes

group_weights

An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-groupweights

segment_overrides

An array of structures that you can use to specify different traffic splits for one or more audience segments .

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.

For more information, see Use segments to focus your audience .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-segmentoverrides

start_time

The date and time to start this step of the launch.

Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-starttime