CfnFeatureProps

class aws_cdk.aws_evidently.CfnFeatureProps(*, name, project, variations, default_variation=None, description=None, entity_overrides=None, evaluation_strategy=None, tags=None)

Bases: object

Properties for defining a CfnFeature.

Parameters:

name (str) – The name for the feature. It can include up to 127 characters.
project (str) – The name or ARN of the project that is to contain the new feature.
variations (Union[IResolvable, Sequence[Union[IResolvable, VariationObjectProperty, Dict[str, Any]]]]) – 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 ).
default_variation (Optional[str]) – 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.
description (Optional[str]) – An optional description of the feature.
entity_overrides (Union[IResolvable, Sequence[Union[IResolvable, EntityOverrideProperty, Dict[str, Any]]], None]) – 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.
evaluation_strategy (Optional[str]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_evidently as evidently

cfn_feature_props = evidently.CfnFeatureProps(
    name="name",
    project="project",
    variations=[evidently.CfnFeature.VariationObjectProperty(
        variation_name="variationName",

        # the properties below are optional
        boolean_value=False,
        double_value=123,
        long_value=123,
        string_value="stringValue"
    )],

    # the properties below are optional
    default_variation="defaultVariation",
    description="description",
    entity_overrides=[evidently.CfnFeature.EntityOverrideProperty(
        entity_id="entityId",
        variation="variation"
    )],
    evaluation_strategy="evaluationStrategy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

default_variation

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-defaultvariation

description

An optional description of the feature.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-description

entity_overrides

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-entityoverrides

evaluation_strategy

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-evaluationstrategy

name

The name for the feature.

It can include up to 127 characters.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-name

project

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-project

tags

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 .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-tags

variations

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-variations