@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
117 lines (116 loc) • 5.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::Evidently::Feature.
*/
export declare class Feature extends pulumi.CustomResource {
/**
* Get an existing Feature resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Feature;
/**
* Returns true if the given object is an instance of Feature. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Feature;
/**
* The ARN of the feature. For example, `arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature` .
*/
readonly arn: pulumi.Output<string>;
/**
* 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.
*/
readonly defaultVariation: pulumi.Output<string | undefined>;
/**
* An optional description of the feature.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly entityOverrides: pulumi.Output<outputs.evidently.FeatureEntityOverride[] | undefined>;
/**
* 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.
*/
readonly evaluationStrategy: pulumi.Output<enums.evidently.FeatureEvaluationStrategy | undefined>;
/**
* The name for the feature. It can include up to 127 characters.
*/
readonly name: pulumi.Output<string>;
/**
* The name or ARN of the project that is to contain the new feature.
*/
readonly project: pulumi.Output<string>;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* 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` ).
*/
readonly variations: pulumi.Output<outputs.evidently.FeatureVariationObject[]>;
/**
* Create a Feature resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: FeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Feature resource.
*/
export interface FeatureArgs {
/**
* 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.
*/
defaultVariation?: pulumi.Input<string>;
/**
* An optional description of the feature.
*/
description?: pulumi.Input<string>;
/**
* 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.
*/
entityOverrides?: pulumi.Input<pulumi.Input<inputs.evidently.FeatureEntityOverrideArgs>[]>;
/**
* 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.
*/
evaluationStrategy?: pulumi.Input<enums.evidently.FeatureEvaluationStrategy>;
/**
* The name for the feature. It can include up to 127 characters.
*/
name?: pulumi.Input<string>;
/**
* The name or ARN of the project that is to contain the new feature.
*/
project: pulumi.Input<string>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* 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` ).
*/
variations: pulumi.Input<pulumi.Input<inputs.evidently.FeatureVariationObjectArgs>[]>;
}