software.amazon.awscdk.services.evidently

Interface CfnFeatureProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFeatureProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:34.923Z")
 @Stability(value=Stable)
public interface CfnFeatureProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFeature`.

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.*;
 CfnFeatureProps cfnFeatureProps = CfnFeatureProps.builder()
         .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	Interface and Description
static class	CfnFeatureProps.Builder A builder for CfnFeatureProps
static class	CfnFeatureProps.Jsii$Proxy An implementation for CfnFeatureProps

Method Summary

Modifier and Type	Method and Description
static CfnFeatureProps.Builder	builder()
default String	getDefaultVariation() The name of the variation to use as the default variation.
default String	getDescription() An optional description of the feature.
default Object	getEntityOverrides() Specify users that should always be served a specific variation of a feature.
default 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.
default List<CfnTag>	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

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

The name for the feature.

It can include up to 127 characters.

getProject

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

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

getVariations

@Stability(value=Stable)
 @NotNull
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 ).

getDefaultVariation

@Stability(value=Stable)
 @Nullable
default 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.

getDescription

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

An optional description of the feature.

getEntityOverrides

@Stability(value=Stable)
 @Nullable
default 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.

getEvaluationStrategy

@Stability(value=Stable)
 @Nullable
default 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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> 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 .

builder

@Stability(value=Stable)
static CfnFeatureProps.Builder builder()

Returns:

a CfnFeatureProps.Builder of CfnFeatureProps