Package software.amazon.awscdk.services.evidently

Interface CfnLaunchProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:07.527Z")
@Stability(Stable)
public interface CfnLaunchProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.evidently.*;
 CfnLaunchProps cfnLaunchProps = CfnLaunchProps.builder()
         .groups(List.of(LaunchGroupObjectProperty.builder()
                 .feature("feature")
                 .groupName("groupName")
                 .variation("variation")
                 // the properties below are optional
                 .description("description")
                 .build()))
         .name("name")
         .project("project")
         .scheduledSplitsConfig(List.of(StepConfigProperty.builder()
                 .groupWeights(List.of(GroupToWeightProperty.builder()
                         .groupName("groupName")
                         .splitWeight(123)
                         .build()))
                 .startTime("startTime")
                 // the properties below are optional
                 .segmentOverrides(List.of(SegmentOverrideProperty.builder()
                         .evaluationOrder(123)
                         .segment("segment")
                         .weights(List.of(GroupToWeightProperty.builder()
                                 .groupName("groupName")
                                 .splitWeight(123)
                                 .build()))
                         .build()))
                 .build()))
         // the properties below are optional
         .description("description")
         .executionStatus(ExecutionStatusObjectProperty.builder()
                 .status("status")
                 // the properties below are optional
                 .desiredState("desiredState")
                 .reason("reason")
                 .build())
         .metricMonitors(List.of(MetricDefinitionObjectProperty.builder()
                 .entityIdKey("entityIdKey")
                 .metricName("metricName")
                 .valueKey("valueKey")
                 // the properties below are optional
                 .eventPattern("eventPattern")
                 .unitLabel("unitLabel")
                 .build()))
         .randomizationSalt("randomizationSalt")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLaunchProps.Builder	A builder for CfnLaunchProps
static final class	CfnLaunchProps.Jsii$Proxy	An implementation for CfnLaunchProps

Method Summary

Modifier and Type	Method	Description
static CfnLaunchProps.Builder	builder()
default String	getDescription()	An optional description for the launch.
default Object	getExecutionStatus()	A structure that you can use to start and stop the launch.
Object	getGroups()	An array of structures that contains the feature and variations that are to be used for the launch.
default Object	getMetricMonitors()	An array of structures that define the metrics that will be used to monitor the launch performance.
String	getName()	The name for the launch.
String	getProject()	The name or ARN of the project that you want to create the launch in.
default String	getRandomizationSalt()	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.
Object	getScheduledSplitsConfig()	An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
default List<CfnTag>	getTags()	Assigns one or more tags (key-value pairs) to the launch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroups

@Stability(Stable)
@NotNull
Object getGroups()

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.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name for the launch.

It can include up to 127 characters.

See Also:

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

getProject

@Stability(Stable)
@NotNull
String getProject()

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

See Also:

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

getScheduledSplitsConfig

@Stability(Stable)
@NotNull
Object getScheduledSplitsConfig()

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

An optional description for the launch.

See Also:

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

getExecutionStatus

@Stability(Stable)
@Nullable
default Object getExecutionStatus()

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

See Also:

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

getMetricMonitors

@Stability(Stable)
@Nullable
default Object getMetricMonitors()

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.

See Also:

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

getRandomizationSalt

@Stability(Stable)
@Nullable
default String getRandomizationSalt()

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnLaunchProps.Builder builder()

Returns:

a CfnLaunchProps.Builder of CfnLaunchProps