1. Packages
  2. AWS Native
  3. API Docs
  4. evidently
  5. Feature

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.evidently.Feature

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource Type definition for AWS::Evidently::Feature.

    Create Feature Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Feature(name: string, args: FeatureArgs, opts?: CustomResourceOptions);
    @overload
    def Feature(resource_name: str,
                args: FeatureArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Feature(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                project: Optional[str] = None,
                variations: Optional[Sequence[FeatureVariationObjectArgs]] = None,
                default_variation: Optional[str] = None,
                description: Optional[str] = None,
                entity_overrides: Optional[Sequence[FeatureEntityOverrideArgs]] = None,
                evaluation_strategy: Optional[FeatureEvaluationStrategy] = None,
                name: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewFeature(ctx *Context, name string, args FeatureArgs, opts ...ResourceOption) (*Feature, error)
    public Feature(string name, FeatureArgs args, CustomResourceOptions? opts = null)
    public Feature(String name, FeatureArgs args)
    public Feature(String name, FeatureArgs args, CustomResourceOptions options)
    
    type: aws-native:evidently:Feature
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FeatureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FeatureArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FeatureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FeatureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FeatureArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const featureResource = new aws_native.evidently.Feature("featureResource", {
        project: "string",
        variations: [{
            booleanValue: false,
            doubleValue: 0,
            longValue: 0,
            stringValue: "string",
            variationName: "string",
        }],
        defaultVariation: "string",
        description: "string",
        entityOverrides: [{
            entityId: "string",
            variation: "string",
        }],
        evaluationStrategy: aws_native.evidently.FeatureEvaluationStrategy.AllRules,
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Feature Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Feature resource accepts the following input properties:

    Project string
    The name or ARN of the project that is to contain the new feature.
    Variations List<Pulumi.AwsNative.Evidently.Inputs.FeatureVariationObject>

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

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

    Description string
    An optional description of the feature.
    EntityOverrides List<Pulumi.AwsNative.Evidently.Inputs.FeatureEntityOverride>
    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.
    EvaluationStrategy Pulumi.AwsNative.Evidently.FeatureEvaluationStrategy
    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.
    Name string
    The name for the feature. It can include up to 127 characters.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Project string
    The name or ARN of the project that is to contain the new feature.
    Variations []FeatureVariationObjectArgs

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

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

    Description string
    An optional description of the feature.
    EntityOverrides []FeatureEntityOverrideArgs
    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.
    EvaluationStrategy FeatureEvaluationStrategy
    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.
    Name string
    The name for the feature. It can include up to 127 characters.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    project String
    The name or ARN of the project that is to contain the new feature.
    variations List<FeatureVariationObject>

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

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

    description String
    An optional description of the feature.
    entityOverrides List<FeatureEntityOverride>
    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.
    evaluationStrategy FeatureEvaluationStrategy
    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.
    name String
    The name for the feature. It can include up to 127 characters.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    project string
    The name or ARN of the project that is to contain the new feature.
    variations FeatureVariationObject[]

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

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

    description string
    An optional description of the feature.
    entityOverrides FeatureEntityOverride[]
    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.
    evaluationStrategy FeatureEvaluationStrategy
    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.
    name string
    The name for the feature. It can include up to 127 characters.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    project str
    The name or ARN of the project that is to contain the new feature.
    variations Sequence[FeatureVariationObjectArgs]

    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 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 str
    An optional description of the feature.
    entity_overrides Sequence[FeatureEntityOverrideArgs]
    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 FeatureEvaluationStrategy
    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.
    name str
    The name for the feature. It can include up to 127 characters.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    project String
    The name or ARN of the project that is to contain the new feature.
    variations List<Property Map>

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

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

    description String
    An optional description of the feature.
    entityOverrides List<Property Map>
    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.
    evaluationStrategy "ALL_RULES" | "DEFAULT_VARIATION"
    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.
    name String
    The name for the feature. It can include up to 127 characters.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Feature resource produces the following output properties:

    Arn string
    The ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature .
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FeatureEntityOverride, FeatureEntityOverrideArgs

    EntityId string
    The entity ID to be served the variation specified in Variation .
    Variation string
    The name of the variation to serve to the user session that matches the EntityId .
    EntityId string
    The entity ID to be served the variation specified in Variation .
    Variation string
    The name of the variation to serve to the user session that matches the EntityId .
    entityId String
    The entity ID to be served the variation specified in Variation .
    variation String
    The name of the variation to serve to the user session that matches the EntityId .
    entityId string
    The entity ID to be served the variation specified in Variation .
    variation string
    The name of the variation to serve to the user session that matches the EntityId .
    entity_id str
    The entity ID to be served the variation specified in Variation .
    variation str
    The name of the variation to serve to the user session that matches the EntityId .
    entityId String
    The entity ID to be served the variation specified in Variation .
    variation String
    The name of the variation to serve to the user session that matches the EntityId .

    FeatureEvaluationStrategy, FeatureEvaluationStrategyArgs

    AllRules
    ALL_RULES
    DefaultVariation
    DEFAULT_VARIATION
    FeatureEvaluationStrategyAllRules
    ALL_RULES
    FeatureEvaluationStrategyDefaultVariation
    DEFAULT_VARIATION
    AllRules
    ALL_RULES
    DefaultVariation
    DEFAULT_VARIATION
    AllRules
    ALL_RULES
    DefaultVariation
    DEFAULT_VARIATION
    ALL_RULES
    ALL_RULES
    DEFAULT_VARIATION
    DEFAULT_VARIATION
    "ALL_RULES"
    ALL_RULES
    "DEFAULT_VARIATION"
    DEFAULT_VARIATION

    FeatureVariationObject, FeatureVariationObjectArgs

    BooleanValue bool
    The value assigned to this variation, if the variation type is boolean.
    DoubleValue double
    The value assigned to this variation, if the variation type is a double.
    LongValue double
    The value assigned to this variation, if the variation type is a long.
    StringValue string
    The value assigned to this variation, if the variation type is a string.
    VariationName string
    A name for the variation. It can include up to 127 characters.
    BooleanValue bool
    The value assigned to this variation, if the variation type is boolean.
    DoubleValue float64
    The value assigned to this variation, if the variation type is a double.
    LongValue float64
    The value assigned to this variation, if the variation type is a long.
    StringValue string
    The value assigned to this variation, if the variation type is a string.
    VariationName string
    A name for the variation. It can include up to 127 characters.
    booleanValue Boolean
    The value assigned to this variation, if the variation type is boolean.
    doubleValue Double
    The value assigned to this variation, if the variation type is a double.
    longValue Double
    The value assigned to this variation, if the variation type is a long.
    stringValue String
    The value assigned to this variation, if the variation type is a string.
    variationName String
    A name for the variation. It can include up to 127 characters.
    booleanValue boolean
    The value assigned to this variation, if the variation type is boolean.
    doubleValue number
    The value assigned to this variation, if the variation type is a double.
    longValue number
    The value assigned to this variation, if the variation type is a long.
    stringValue string
    The value assigned to this variation, if the variation type is a string.
    variationName string
    A name for the variation. It can include up to 127 characters.
    boolean_value bool
    The value assigned to this variation, if the variation type is boolean.
    double_value float
    The value assigned to this variation, if the variation type is a double.
    long_value float
    The value assigned to this variation, if the variation type is a long.
    string_value str
    The value assigned to this variation, if the variation type is a string.
    variation_name str
    A name for the variation. It can include up to 127 characters.
    booleanValue Boolean
    The value assigned to this variation, if the variation type is boolean.
    doubleValue Number
    The value assigned to this variation, if the variation type is a double.
    longValue Number
    The value assigned to this variation, if the variation type is a long.
    stringValue String
    The value assigned to this variation, if the variation type is a string.
    variationName String
    A name for the variation. It can include up to 127 characters.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi