software.amazon.awscdk.services.evidently

Class CfnFeature

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.evidently.CfnFeature

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:34.921Z")
 @Stability(value=Stable)
public class CfnFeature
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Evidently::Feature`.

Creates or updates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject .

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.*;
 CfnFeature cfnFeature = CfnFeature.Builder.create(this, "MyCfnFeature")
         .name("name")
         .project("project")
         .variations(List.of(VariationObjectProperty.builder()
                 .booleanValue(false)
                 .doubleValue(123)
                 .longValue(123)
                 .stringValue("stringValue")
                 .variationName("variationName")
                 .build()))
         // the properties below are optional
         .defaultVariation("defaultVariation")
         .description("description")
         .entityOverrides(List.of(EntityOverrideProperty.builder()
                 .entityId("entityId")
                 .variation("variation")
                 .build()))
         .evaluationStrategy("evaluationStrategy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFeature.Builder A fluent builder for CfnFeature.
static interface	CfnFeature.EntityOverrideProperty A set of key-value pairs that specify users who should always be served a specific variation of a feature.
static interface	CfnFeature.VariationObjectProperty This structure contains the name and variation value of one variation of a feature.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnFeature(Construct scope, String id, CfnFeatureProps props) Create a new `AWS::Evidently::Feature`.
protected	CfnFeature(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFeature(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the feature.
protected Map<String,Object>	getCfnProperties()
String	getDefaultVariation() The name of the variation to use as the default variation.
String	getDescription() An optional description of the feature.
Object	getEntityOverrides() Specify users that should always be served a specific variation of a feature.
String	getEvaluationStrategy() Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments.
String	getName() The name for the feature.
String	getProject() The name or ARN of the project that is to contain the new feature.
TagManager	getTags() Assigns one or more tags (key-value pairs) to the feature.
Object	getVariations() An array of structures that contain the configuration of the feature's different variations.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefaultVariation(String value) The name of the variation to use as the default variation.
void	setDescription(String value) An optional description of the feature.
void	setEntityOverrides(IResolvable value) Specify users that should always be served a specific variation of a feature.
void	setEntityOverrides(List<Object> value) Specify users that should always be served a specific variation of a feature.
void	setEvaluationStrategy(String value) Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments.
void	setName(String value) The name for the feature.
void	setProject(String value) The name or ARN of the project that is to contain the new feature.
void	setVariations(IResolvable value) An array of structures that contain the configuration of the feature's different variations.
void	setVariations(List<Object> value) An array of structures that contain the configuration of the feature's different variations.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnFeature

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

CfnFeature

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

CfnFeature

@Stability(value=Stable)
public CfnFeature(@NotNull
                                           Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnFeatureProps props)

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

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

The ARN of the feature.

For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Assigns one or more tags (key-value pairs) to the feature.

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

For more information, see Tagging AWS resources .

getName

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

The name for the feature.

It can include up to 127 characters.

setName

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

The name for the feature.

It can include up to 127 characters.

getProject

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

The name or ARN of the project that is to contain the new feature.

setProject

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

The name or ARN of the project that is to contain the new feature.

getVariations

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

An array of structures that contain the configuration of the feature's different variations.

Each VariationObject in the Variations array for a feature must have the same type of value ( BooleanValue , DoubleValue , LongValue or StringValue ).

setVariations

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

An array of structures that contain the configuration of the feature's different variations.

Each VariationObject in the Variations array for a feature must have the same type of value ( BooleanValue , DoubleValue , LongValue or StringValue ).

setVariations

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

An array of structures that contain the configuration of the feature's different variations.

Each VariationObject in the Variations array for a feature must have the same type of value ( BooleanValue , DoubleValue , LongValue or StringValue ).

getDefaultVariation

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

The name of the variation to use as the default variation.

The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the Variations structure.

If you omit DefaultVariation , the first variation listed in the Variations structure is used as the default variation.

setDefaultVariation

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

The name of the variation to use as the default variation.

The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the Variations structure.

If you omit DefaultVariation , the first variation listed in the Variations structure is used as the default variation.

getDescription

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

An optional description of the feature.

setDescription

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

An optional description of the feature.

getEntityOverrides

@Stability(value=Stable)
 @Nullable
public Object getEntityOverrides()

Specify users that should always be served a specific variation of a feature.

Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

setEntityOverrides

@Stability(value=Stable)
public void setEntityOverrides(@Nullable
                                                        IResolvable value)

Specify users that should always be served a specific variation of a feature.

Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

setEntityOverrides

@Stability(value=Stable)
public void setEntityOverrides(@Nullable
                                                        List<Object> value)

Specify users that should always be served a specific variation of a feature.

Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

getEvaluationStrategy

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

Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments.

Specify DEFAULT_VARIATION to serve the default variation to all users instead.

setEvaluationStrategy

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

Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments.

Specify DEFAULT_VARIATION to serve the default variation to all users instead.