Class CfnLaunch
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.evidently.CfnLaunch
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:43.780Z")
@Stability(Stable)
public class CfnLaunch
extends CfnResource
implements IInspectable, ITaggable
Creates or updates a launch of a given feature.
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.
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.*; CfnLaunch cfnLaunch = CfnLaunch.Builder.create(this, "MyCfnLaunch") .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 TypeClassDescriptionstatic final class
A fluent builder forCfnLaunch
.static interface
Use this structure to start and stop the launch.static interface
A structure containing the percentage of launch traffic to allocate to one launch group.static interface
A structure that defines one launch group in a launch.static interface
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.static interface
Use this structure to specify different traffic splits for one or more audience segments .static interface
A structure that defines when each step of the launch is to start, and how much launch traffic is to be allocated to each variation during each step.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnLaunch
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnLaunch
(software.amazon.jsii.JsiiObjectRef objRef) CfnLaunch
(software.constructs.Construct scope, String id, CfnLaunchProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the launch.An optional description for the launch.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.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.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()
Tag Manager which manages the tags for this resource.Assigns one or more tags (key-value pairs) to the launch.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) An optional description for the launch.void
setExecutionStatus
(IResolvable value) A structure that you can use to start and stop the launch.void
A structure that you can use to start and stop the launch.void
An array of structures that contains the feature and variations that are to be used for the launch.void
setGroups
(IResolvable value) An array of structures that contains the feature and variations that are to be used for the launch.void
setMetricMonitors
(List<Object> value) An array of structures that define the metrics that will be used to monitor the launch performance.void
setMetricMonitors
(IResolvable value) An array of structures that define the metrics that will be used to monitor the launch performance.void
The name for the launch.void
setProject
(String value) The name or ARN of the project that you want to create the launch in.void
setRandomizationSalt
(String value) 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.void
setScheduledSplitsConfig
(List<Object> value) An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.void
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.void
setTagsRaw
(List<CfnTag> value) Assigns one or more tags (key-value pairs) to the launch.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnLaunch
protected CfnLaunch(software.amazon.jsii.JsiiObjectRef objRef) -
CfnLaunch
protected CfnLaunch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnLaunch
@Stability(Stable) public CfnLaunch(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLaunchProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the launch.For example,
arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getGroups
An array of structures that contains the feature and variations that are to be used for the launch. -
setGroups
An array of structures that contains the feature and variations that are to be used for the launch. -
setGroups
An array of structures that contains the feature and variations that are to be used for the launch. -
getName
The name for the launch. -
setName
The name for the launch. -
getProject
The name or ARN of the project that you want to create the launch in. -
setProject
The name or ARN of the project that you want to create the launch in. -
getScheduledSplitsConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. -
setScheduledSplitsConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. -
setScheduledSplitsConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. -
getDescription
An optional description for the launch. -
setDescription
An optional description for the launch. -
getExecutionStatus
A structure that you can use to start and stop the launch. -
setExecutionStatus
A structure that you can use to start and stop the launch. -
setExecutionStatus
@Stability(Stable) public void setExecutionStatus(@Nullable CfnLaunch.ExecutionStatusObjectProperty value) A structure that you can use to start and stop the launch. -
getMetricMonitors
An array of structures that define the metrics that will be used to monitor the launch performance. -
setMetricMonitors
An array of structures that define the metrics that will be used to monitor the launch performance. -
setMetricMonitors
An array of structures that define the metrics that will be used to monitor the launch performance. -
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. -
setRandomizationSalt
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. -
getTagsRaw
Assigns one or more tags (key-value pairs) to the launch. -
setTagsRaw
Assigns one or more tags (key-value pairs) to the launch.
-