Interface ICfnLaunchMixinProps

Properties for CfnLaunchPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Evidently

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnLaunchMixinProps

Syntax (vb)

Public Interface ICfnLaunchMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Evidently;

             var cfnLaunchMixinProps = new CfnLaunchMixinProps {
                 Description = "description",
                 ExecutionStatus = new ExecutionStatusObjectProperty {
                     DesiredState = "desiredState",
                     Reason = "reason",
                     Status = "status"
                 },
                 Groups = new [] { new LaunchGroupObjectProperty {
                     Description = "description",
                     Feature = "feature",
                     GroupName = "groupName",
                     Variation = "variation"
                 } },
                 MetricMonitors = new [] { new MetricDefinitionObjectProperty {
                     EntityIdKey = "entityIdKey",
                     EventPattern = "eventPattern",
                     MetricName = "metricName",
                     UnitLabel = "unitLabel",
                     ValueKey = "valueKey"
                 } },
                 Name = "name",
                 Project = "project",
                 RandomizationSalt = "randomizationSalt",
                 ScheduledSplitsConfig = new [] { new StepConfigProperty {
                     GroupWeights = new [] { new GroupToWeightProperty {
                         GroupName = "groupName",
                         SplitWeight = 123
                     } },
                     SegmentOverrides = new [] { new SegmentOverrideProperty {
                         EvaluationOrder = 123,
                         Segment = "segment",
                         Weights = new [] { new GroupToWeightProperty {
                             GroupName = "groupName",
                             SplitWeight = 123
                         } }
                     } },
                     StartTime = "startTime"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

Description	An optional description for the launch.
ExecutionStatus	A structure that you can use to start and stop the launch.
Groups	An array of structures that contains the feature and variations that are to be used for the launch.
MetricMonitors	An array of structures that define the metrics that will be used to monitor the launch performance.
Name	The name for the launch.
Project	The name or ARN of the project that you want to create the launch in.
RandomizationSalt	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.
ScheduledSplitsConfig	An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
Tags	Assigns one or more tags (key-value pairs) to the launch.

Properties

Description

An optional description for the launch.

string? Description { get; }

Property Value

string

Remarks

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

ExecutionStatus

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

object? ExecutionStatus { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnLaunchPropsMixin.IExecutionStatusObjectProperty

Groups

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

object? Groups { get; }

Property Value

object

Remarks

You can up to five launch groups in a launch.

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

Type union: either IResolvable or (either IResolvable or CfnLaunchPropsMixin.ILaunchGroupObjectProperty)[]

MetricMonitors

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

object? MetricMonitors { get; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or (either IResolvable or CfnLaunchPropsMixin.IMetricDefinitionObjectProperty)[]

Name

The name for the launch.

string? Name { get; }

Property Value

string

Remarks

It can include up to 127 characters.

See: 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.

object? Project { get; }

Property Value

object

Remarks

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

Type union: either string or IProjectRef

RandomizationSalt

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.

string? RandomizationSalt { get; }

Property Value

string

Remarks

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

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

ScheduledSplitsConfig

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

object? ScheduledSplitsConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnLaunchPropsMixin.IStepConfigProperty)[]