Package software.amazon.awscdk.cfnpropertymixins.services.evidently

Class CfnFeaturePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.evidently.CfnFeaturePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFeaturePropsMixin>

Enclosing class:

CfnFeaturePropsMixin

@Stability(Stable)
public static final class CfnFeaturePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFeaturePropsMixin>

A fluent builder for CfnFeaturePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnFeaturePropsMixin	build()
static CfnFeaturePropsMixin.Builder	create()
static CfnFeaturePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnFeaturePropsMixin.Builder	defaultVariation(String defaultVariation)	The name of the variation to use as the default variation.
CfnFeaturePropsMixin.Builder	description(String description)	An optional description of the feature.
CfnFeaturePropsMixin.Builder	entityOverrides(List<? extends Object> entityOverrides)	Specify users that should always be served a specific variation of a feature.
CfnFeaturePropsMixin.Builder	entityOverrides(IResolvable entityOverrides)	Specify users that should always be served a specific variation of a feature.
CfnFeaturePropsMixin.Builder	evaluationStrategy(String evaluationStrategy)	Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments.
CfnFeaturePropsMixin.Builder	name(String name)	The name for the feature.
CfnFeaturePropsMixin.Builder	project(String project)	The name or ARN of the project that is to contain the new feature.
CfnFeaturePropsMixin.Builder	project(IProjectRef project)	The name or ARN of the project that is to contain the new feature.
CfnFeaturePropsMixin.Builder	tags(List<? extends CfnTag> tags)	Assigns one or more tags (key-value pairs) to the feature.
CfnFeaturePropsMixin.Builder	variations(List<? extends Object> variations)	An array of structures that contain the configuration of the feature's different variations.
CfnFeaturePropsMixin.Builder	variations(IResolvable variations)	An array of structures that contain the configuration of the feature's different variations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnFeaturePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnFeaturePropsMixin.Builder.

create

@Stability(Stable)
public static CfnFeaturePropsMixin.Builder create()

Returns:

a new instance of CfnFeaturePropsMixin.Builder.

defaultVariation

@Stability(Stable)
public CfnFeaturePropsMixin.Builder defaultVariation(String defaultVariation)

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.

Parameters:

defaultVariation - The name of the variation to use as the default variation. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnFeaturePropsMixin.Builder description(String description)

An optional description of the feature.

Parameters:

description - An optional description of the feature. This parameter is required.

Returns:

this

See Also:

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

entityOverrides

@Stability(Stable)
public CfnFeaturePropsMixin.Builder entityOverrides(IResolvable entityOverrides)

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.

Parameters:

entityOverrides - Specify users that should always be served a specific variation of a feature. This parameter is required.

Returns:

this

See Also:

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

entityOverrides

@Stability(Stable)
public CfnFeaturePropsMixin.Builder entityOverrides(List<? extends Object> entityOverrides)

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.

Parameters:

entityOverrides - Specify users that should always be served a specific variation of a feature. This parameter is required.

Returns:

this

See Also:

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

evaluationStrategy

@Stability(Stable)
public CfnFeaturePropsMixin.Builder evaluationStrategy(String evaluationStrategy)

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.

Parameters:

evaluationStrategy - Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnFeaturePropsMixin.Builder name(String name)

The name for the feature.

It can include up to 127 characters.

Parameters:

name - The name for the feature. This parameter is required.

Returns:

this

See Also:

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

project

@Stability(Stable)
public CfnFeaturePropsMixin.Builder project(String project)

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

Parameters:

project - The name or ARN of the project that is to contain the new feature. This parameter is required.

Returns:

this

See Also:

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

project

@Stability(Stable)
public CfnFeaturePropsMixin.Builder project(IProjectRef project)

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

Parameters:

project - The name or ARN of the project that is to contain the new feature. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnFeaturePropsMixin.Builder tags(List<? extends CfnTag> 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 .

Parameters:

tags - Assigns one or more tags (key-value pairs) to the feature. This parameter is required.

Returns:

this

See Also:

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

variations

@Stability(Stable)
public CfnFeaturePropsMixin.Builder variations(IResolvable 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 ).

Parameters:

variations - An array of structures that contain the configuration of the feature's different variations. This parameter is required.

Returns:

this

See Also:

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

variations

@Stability(Stable)
public CfnFeaturePropsMixin.Builder variations(List<? extends Object> 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 ).

Parameters:

variations - An array of structures that contain the configuration of the feature's different variations. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFeaturePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFeaturePropsMixin>

Returns:

a newly built instance of CfnFeaturePropsMixin.