software.amazon.awscdk.services.evidently

Interface CfnLaunchProps

All Known Implementing Classes:

CfnLaunchProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.161Z")
public interface CfnLaunchProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getGroups

java.lang.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.

getName

java.lang.String getName()

The name for the launch.

It can include up to 127 characters.

getProject

java.lang.String getProject()

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

getScheduledSplitsConfig

java.lang.Object getScheduledSplitsConfig()

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

getDescription

default java.lang.String getDescription()

An optional description for the launch.

getExecutionStatus

default java.lang.Object getExecutionStatus()

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

getMetricMonitors

default java.lang.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.

getRandomizationSalt

default java.lang.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 .

getTags

default java.util.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 .

builder

static CfnLaunchProps.Builder builder()

Returns:

a CfnLaunchProps.Builder of CfnLaunchProps