# AWS::Evidently Construct Library

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as evidently from 'aws-cdk-lib/aws-evidently';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for Evidently construct libraries](https://constructs.dev/search?q=evidently)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::Evidently resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Evidently.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::Evidently](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Evidently.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnExperiment`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperiment) | Construct (L1) | Creates or updates an Evidently *experiment* . |
| [`CfnFeature`](/v2/docs/aws-cdk-lib.aws_evidently.CfnFeature) | Construct (L1) | Creates or updates an Evidently *feature* that you want to launch or test. |
| [`CfnLaunch`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch) | Construct (L1) | Creates or updates a *launch* of a given feature. |
| [`CfnProject`](/v2/docs/aws-cdk-lib.aws_evidently.CfnProject) | Construct (L1) | Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. |
| [`CfnSegment`](/v2/docs/aws-cdk-lib.aws_evidently.CfnSegment) | Construct (L1) | Creates or updates a *segment* of your audience. |
| [`CfnExperiment.MetricGoalObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperiment.MetricGoalObjectProperty) | Struct | Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment. |
| [`CfnExperiment.OnlineAbConfigObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperiment.OnlineAbConfigObjectProperty) | Struct | A structure that contains the configuration of which variation to use as the "control" version. |
| [`CfnExperiment.RunningStatusObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperiment.RunningStatusObjectProperty) | Struct | Use this structure to start and stop the experiment. |
| [`CfnExperiment.TreatmentObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperiment.TreatmentObjectProperty) | Struct | A structure that defines one treatment in an experiment. |
| [`CfnExperiment.TreatmentToWeightProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperiment.TreatmentToWeightProperty) | Struct | This structure defines how much experiment traffic to allocate to one treatment used in the experiment. |
| [`CfnExperimentProps`](/v2/docs/aws-cdk-lib.aws_evidently.CfnExperimentProps) | Struct | Properties for defining a `CfnExperiment`. |
| [`CfnFeature.EntityOverrideProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnFeature.EntityOverrideProperty) | Struct | A set of key-value pairs that specify users who should always be served a specific variation of a feature. |
| [`CfnFeature.VariationObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnFeature.VariationObjectProperty) | Struct | This structure contains the name and variation value of one variation of a feature. |
| [`CfnFeatureProps`](/v2/docs/aws-cdk-lib.aws_evidently.CfnFeatureProps) | Struct | Properties for defining a `CfnFeature`. |
| [`CfnLaunch.ExecutionStatusObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch.ExecutionStatusObjectProperty) | Struct | Use this structure to start and stop the launch. |
| [`CfnLaunch.GroupToWeightProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch.GroupToWeightProperty) | Struct | A structure containing the percentage of launch traffic to allocate to one launch group. |
| [`CfnLaunch.LaunchGroupObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch.LaunchGroupObjectProperty) | Struct | A structure that defines one launch group in a launch. |
| [`CfnLaunch.MetricDefinitionObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch.MetricDefinitionObjectProperty) | Struct | This structure defines a metric that you want to use to evaluate the variations during a launch or experiment. |
| [`CfnLaunch.SegmentOverrideProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch.SegmentOverrideProperty) | Struct | Use this structure to specify different traffic splits for one or more audience *segments* . |
| [`CfnLaunch.StepConfigProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunch.StepConfigProperty) | Struct | A structure that defines when each step of the launch is to start, and how much launch traffic is to be allocated to each variation during each step. |
| [`CfnLaunchProps`](/v2/docs/aws-cdk-lib.aws_evidently.CfnLaunchProps) | Struct | Properties for defining a `CfnLaunch`. |
| [`CfnProject.AppConfigResourceObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnProject.AppConfigResourceObjectProperty) | Struct | This is a structure that defines the configuration of how your application integrates with AWS AppConfig to run client-side evaluation. |
| [`CfnProject.DataDeliveryObjectProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnProject.DataDeliveryObjectProperty) | Struct | A structure that contains information about where Evidently is to store evaluation events for longer term storage. |
| [`CfnProject.S3DestinationProperty`](/v2/docs/aws-cdk-lib.aws_evidently.CfnProject.S3DestinationProperty) | Struct | If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix. |
| [`CfnProjectProps`](/v2/docs/aws-cdk-lib.aws_evidently.CfnProjectProps) | Struct | Properties for defining a `CfnProject`. |
| [`CfnSegmentProps`](/v2/docs/aws-cdk-lib.aws_evidently.CfnSegmentProps) | Struct | Properties for defining a `CfnSegment`. |