software.amazon.awscdk.services.evidently

Class CfnExperiment

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.CfnExperiment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.697Z")
 @Stability(value=Stable)
public class CfnExperiment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Evidently::Experiment`.

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.*;
 CfnExperiment cfnExperiment = CfnExperiment.Builder.create(this, "MyCfnExperiment")
         .metricGoals(List.of(MetricGoalObjectProperty.builder()
                 .desiredChange("desiredChange")
                 .entityIdKey("entityIdKey")
                 .eventPattern("eventPattern")
                 .metricName("metricName")
                 .valueKey("valueKey")
                 // the properties below are optional
                 .unitLabel("unitLabel")
                 .build()))
         .name("name")
         .onlineAbConfig(OnlineAbConfigObjectProperty.builder()
                 .controlTreatmentName("controlTreatmentName")
                 .treatmentWeights(List.of(TreatmentToWeightProperty.builder()
                         .splitWeight(123)
                         .treatment("treatment")
                         .build()))
                 .build())
         .project("project")
         .treatments(List.of(TreatmentObjectProperty.builder()
                 .feature("feature")
                 .treatmentName("treatmentName")
                 .variation("variation")
                 // the properties below are optional
                 .description("description")
                 .build()))
         // the properties below are optional
         .description("description")
         .randomizationSalt("randomizationSalt")
         .samplingRate(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnExperiment.Builder A fluent builder for CfnExperiment.
static interface	CfnExperiment.MetricGoalObjectProperty Example:
static interface	CfnExperiment.OnlineAbConfigObjectProperty Example:
static interface	CfnExperiment.TreatmentObjectProperty Example:
static interface	CfnExperiment.TreatmentToWeightProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnExperiment(software.constructs.Construct scope, String id, CfnExperimentProps props) Create a new `AWS::Evidently::Experiment`.
protected	CfnExperiment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnExperiment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Evidently::Experiment.Description`.
Object	getMetricGoals() `AWS::Evidently::Experiment.MetricGoals`.
String	getName() `AWS::Evidently::Experiment.Name`.
Object	getOnlineAbConfig() `AWS::Evidently::Experiment.OnlineAbConfig`.
String	getProject() `AWS::Evidently::Experiment.Project`.
String	getRandomizationSalt() `AWS::Evidently::Experiment.RandomizationSalt`.
Number	getSamplingRate() `AWS::Evidently::Experiment.SamplingRate`.
TagManager	getTags() `AWS::Evidently::Experiment.Tags`.
Object	getTreatments() `AWS::Evidently::Experiment.Treatments`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::Evidently::Experiment.Description`.
void	setMetricGoals(IResolvable value) `AWS::Evidently::Experiment.MetricGoals`.
void	setMetricGoals(List<Object> value) `AWS::Evidently::Experiment.MetricGoals`.
void	setName(String value) `AWS::Evidently::Experiment.Name`.
void	setOnlineAbConfig(CfnExperiment.OnlineAbConfigObjectProperty value) `AWS::Evidently::Experiment.OnlineAbConfig`.
void	setOnlineAbConfig(IResolvable value) `AWS::Evidently::Experiment.OnlineAbConfig`.
void	setProject(String value) `AWS::Evidently::Experiment.Project`.
void	setRandomizationSalt(String value) `AWS::Evidently::Experiment.RandomizationSalt`.
void	setSamplingRate(Number value) `AWS::Evidently::Experiment.SamplingRate`.
void	setTreatments(IResolvable value) `AWS::Evidently::Experiment.Treatments`.
void	setTreatments(List<Object> value) `AWS::Evidently::Experiment.Treatments`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnExperiment

protected CfnExperiment(software.amazon.jsii.JsiiObjectRef objRef)

CfnExperiment

protected CfnExperiment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnExperiment

@Stability(value=Stable)
public CfnExperiment(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnExperimentProps props)

Create a new `AWS::Evidently::Experiment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::Evidently::Experiment.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::Evidently::Experiment.Description`.

getMetricGoals

@Stability(value=Stable)
 @NotNull
public Object getMetricGoals()

`AWS::Evidently::Experiment.MetricGoals`.

setMetricGoals

@Stability(value=Stable)
public void setMetricGoals(@NotNull
                                                    IResolvable value)

`AWS::Evidently::Experiment.MetricGoals`.

setMetricGoals

@Stability(value=Stable)
public void setMetricGoals(@NotNull
                                                    List<Object> value)

`AWS::Evidently::Experiment.MetricGoals`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::Evidently::Experiment.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::Evidently::Experiment.Name`.

getOnlineAbConfig

@Stability(value=Stable)
 @NotNull
public Object getOnlineAbConfig()

`AWS::Evidently::Experiment.OnlineAbConfig`.

setOnlineAbConfig

@Stability(value=Stable)
public void setOnlineAbConfig(@NotNull
                                                       CfnExperiment.OnlineAbConfigObjectProperty value)

`AWS::Evidently::Experiment.OnlineAbConfig`.

setOnlineAbConfig

@Stability(value=Stable)
public void setOnlineAbConfig(@NotNull
                                                       IResolvable value)

`AWS::Evidently::Experiment.OnlineAbConfig`.

getProject

@Stability(value=Stable)
 @NotNull
public String getProject()

`AWS::Evidently::Experiment.Project`.

setProject

@Stability(value=Stable)
public void setProject(@NotNull
                                                String value)

`AWS::Evidently::Experiment.Project`.

getRandomizationSalt

@Stability(value=Stable)
 @Nullable
public String getRandomizationSalt()

`AWS::Evidently::Experiment.RandomizationSalt`.

setRandomizationSalt

@Stability(value=Stable)
public void setRandomizationSalt(@Nullable
                                                          String value)

`AWS::Evidently::Experiment.RandomizationSalt`.

getSamplingRate

@Stability(value=Stable)
 @Nullable
public Number getSamplingRate()

`AWS::Evidently::Experiment.SamplingRate`.

setSamplingRate

@Stability(value=Stable)
public void setSamplingRate(@Nullable
                                                     Number value)

`AWS::Evidently::Experiment.SamplingRate`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Evidently::Experiment.Tags`.

getTreatments

@Stability(value=Stable)
 @NotNull
public Object getTreatments()

`AWS::Evidently::Experiment.Treatments`.

setTreatments

@Stability(value=Stable)
public void setTreatments(@NotNull
                                                   IResolvable value)

`AWS::Evidently::Experiment.Treatments`.

setTreatments

@Stability(value=Stable)
public void setTreatments(@NotNull
                                                   List<Object> value)

`AWS::Evidently::Experiment.Treatments`.