Skip to content

Resource: awsEvidentlyProject

Provides a CloudWatch Evidently Project resource.

Example Usage

Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.evidentlyProject.EvidentlyProject(this, "example", {
  description: "Example Description",
  name: "Example",
  tags: {
    Key1: "example Project",
  },
});

Store evaluation events in a CloudWatch Log Group

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.evidentlyProject.EvidentlyProject(this, "example", {
  dataDelivery: {
    cloudwatchLogs: {
      logGroup: "example-log-group-name",
    },
  },
  description: "Example Description",
  name: "Example",
  tags: {
    Key1: "example Project",
  },
});

Store evaluation events in an S3 bucket

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.evidentlyProject.EvidentlyProject(this, "example", {
  dataDelivery: {
    s3Destination: {
      bucket: "example-bucket-name",
      prefix: "example",
    },
  },
  description: "Example Description",
  name: "Example",
  tags: {
    Key1: "example Project",
  },
});

Argument Reference

The following arguments are supported:

  • dataDelivery - (Optional) A block that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. See below.
  • description - (Optional) Specifies the description of the project.
  • name - (Required) A name for the project.
  • tags - (Optional) Tags to apply to the project. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

The dataDelivery block supports the following arguments:

\~> NOTE: You can't specify both cloudwatchLogs and s3Destination.

  • cloudwatchLogs - (Optional) A block that defines the CloudWatch Log Group that stores the evaluation events. See below.
  • s3Destination - (Optional) A block that defines the S3 bucket and prefix that stores the evaluation events. See below.

The cloudwatchLogs block supports the following arguments:

  • logGroup - (Optional) The name of the log group where the project stores evaluation events.

The s3Destination block supports the following arguments:

  • bucket - (Optional) The name of the bucket in which Evidently stores evaluation events.
  • prefix - (Optional) The bucket prefix in which Evidently stores evaluation events.

Timeouts

Configuration options:

  • create - (Default 2M)
  • delete - (Default 2M)
  • update - (Default 2M)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • activeExperimentCount - The number of ongoing experiments currently in the project.
  • activeLaunchCount - The number of ongoing launches currently in the project.
  • arn - The ARN of the project.
  • createdTime - The date and time that the project is created.
  • experimentCount - The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.
  • featureCount - The number of features currently in the project.
  • id - The ID has the same value as the arn of the project.
  • lastUpdatedTime - The date and time that the project was most recently updated.
  • launchCount - The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.
  • status - The current state of the project. Valid values are available and updating.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

CloudWatch Evidently Project can be imported using the arn, e.g.,

$ terraform import aws_evidently_project.example arn:aws:evidently:us-east-1:123456789012:segment/example