Interface CfnLaunchProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLaunchProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-10-31T19:12:58.600Z")
@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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnLaunchProps
static final class
An implementation forCfnLaunchProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnLaunchProps.Builder
builder()
default String
An optional description for the launch.default Object
A structure that you can use to start and stop the launch.An array of structures that contains the feature and variations that are to be used for the launch.default Object
An array of structures that define the metrics that will be used to monitor the launch performance.getName()
The name for the launch.The name or ARN of the project that you want to create the launch in.default String
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.An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.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
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:
-
getName
The name for the launch.It can include up to 127 characters.
- See Also:
-
getProject
The name or ARN of the project that you want to create the launch in.- See Also:
-
getScheduledSplitsConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.- See Also:
-
getDescription
An optional description for the launch.- See Also:
-
getExecutionStatus
A structure that you can use to start and stop the launch.- See Also:
-
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:
-
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 omitrandomizationSalt
, Evidently uses the launch name as therandomizationsSalt
.- See Also:
-
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:
-
builder
- Returns:
- a
CfnLaunchProps.Builder
ofCfnLaunchProps
-