CfnLaunchProps

class aws_cdk.aws_evidently.CfnLaunchProps(*, groups, name, project, scheduled_splits_config, description=None, execution_status=None, metric_monitors=None, randomization_salt=None, tags=None)

Bases: object

Properties for defining a CfnLaunch.

Parameters:

groups (Union[IResolvable, Sequence[Union[IResolvable, LaunchGroupObjectProperty, Dict[str, Any]]]]) – 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 (str) – The name for the launch. It can include up to 127 characters.
project (str) – The name or ARN of the project that you want to create the launch in.
scheduled_splits_config (Union[IResolvable, Sequence[Union[IResolvable, StepConfigProperty, Dict[str, Any]]]]) – An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
description (Optional[str]) – An optional description for the launch.
execution_status (Union[IResolvable, ExecutionStatusObjectProperty, Dict[str, Any], None]) – A structure that you can use to start and stop the launch.
metric_monitors (Union[IResolvable, Sequence[Union[IResolvable, MetricDefinitionObjectProperty, Dict[str, Any]]], None]) – 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.
randomization_salt (Optional[str]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_launch_props = evidently.CfnLaunchProps(
    groups=[evidently.CfnLaunch.LaunchGroupObjectProperty(
        feature="feature",
        group_name="groupName",
        variation="variation",

        # the properties below are optional
        description="description"
    )],
    name="name",
    project="project",
    scheduled_splits_config=[evidently.CfnLaunch.StepConfigProperty(
        group_weights=[evidently.CfnLaunch.GroupToWeightProperty(
            group_name="groupName",
            split_weight=123
        )],
        start_time="startTime",

        # the properties below are optional
        segment_overrides=[evidently.CfnLaunch.SegmentOverrideProperty(
            evaluation_order=123,
            segment="segment",
            weights=[evidently.CfnLaunch.GroupToWeightProperty(
                group_name="groupName",
                split_weight=123
            )]
        )]
    )],

    # the properties below are optional
    description="description",
    execution_status=evidently.CfnLaunch.ExecutionStatusObjectProperty(
        status="status",

        # the properties below are optional
        desired_state="desiredState",
        reason="reason"
    ),
    metric_monitors=[evidently.CfnLaunch.MetricDefinitionObjectProperty(
        entity_id_key="entityIdKey",
        metric_name="metricName",
        value_key="valueKey",

        # the properties below are optional
        event_pattern="eventPattern",
        unit_label="unitLabel"
    )],
    randomization_salt="randomizationSalt",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

An optional description for the launch.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-description

execution_status

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-executionstatus

groups

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-groups

metric_monitors

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-metricmonitors

name

The name for the launch.

It can include up to 127 characters.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-name

project

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-project

randomization_salt

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 .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-randomizationsalt

scheduled_splits_config

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-scheduledsplitsconfig

tags

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 .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-tags