Class CfnLaunch

Creates or updates a launch of a given feature.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnLaunch
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLaunch : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnLaunch
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

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

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.AWS.Evidently;

var cfnLaunch = new CfnLaunch(this, "MyCfnLaunch", new CfnLaunchProps {
    Groups = new [] { new LaunchGroupObjectProperty {
        Feature = "feature",
        GroupName = "groupName",
        Variation = "variation",

        // the properties below are optional
        Description = "description"
    } },
    Name = "name",
    Project = "project",
    ScheduledSplitsConfig = new [] { new StepConfigProperty {
        GroupWeights = new [] { new GroupToWeightProperty {
            GroupName = "groupName",
            SplitWeight = 123
        } },
        StartTime = "startTime",

        // the properties below are optional
        SegmentOverrides = new [] { new SegmentOverrideProperty {
            EvaluationOrder = 123,
            Segment = "segment",
            Weights = new [] { new GroupToWeightProperty {
                GroupName = "groupName",
                SplitWeight = 123
            } }
        } }
    } },

    // the properties below are optional
    Description = "description",
    ExecutionStatus = new ExecutionStatusObjectProperty {
        Status = "status",

        // the properties below are optional
        DesiredState = "desiredState",
        Reason = "reason"
    },
    MetricMonitors = new [] { new MetricDefinitionObjectProperty {
        EntityIdKey = "entityIdKey",
        MetricName = "metricName",
        ValueKey = "valueKey",

        // the properties below are optional
        EventPattern = "eventPattern",
        UnitLabel = "unitLabel"
    } },
    RandomizationSalt = "randomizationSalt",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnLaunch(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnLaunch(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnLaunch(Construct, String, ICfnLaunchProps)

Properties

AttrArn

The ARN of the launch.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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

Tag Manager which manages the tags for this resource.
TagsRaw

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnLaunch(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnLaunch(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnLaunch(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnLaunch(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnLaunch(Construct, String, ICfnLaunchProps)

public CfnLaunch(Construct scope, string id, ICfnLaunchProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnLaunchProps

Resource properties.

Properties

AttrArn

The ARN of the launch.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

An optional description for the launch.

public virtual string Description { get; set; }
Property Value

System.String

ExecutionStatus

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

public virtual object ExecutionStatus { get; set; }
Property Value

System.Object

Groups

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

public virtual object Groups { get; set; }
Property Value

System.Object

MetricMonitors

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

public virtual object MetricMonitors { get; set; }
Property Value

System.Object

Name

The name for the launch.

public virtual string Name { get; set; }
Property Value

System.String

Project

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

public virtual string Project { get; set; }
Property Value

System.String

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.

public virtual string RandomizationSalt { get; set; }
Property Value

System.String

ScheduledSplitsConfig

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

public virtual object ScheduledSplitsConfig { get; set; }
Property Value

System.Object

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

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

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements