1.204.0

interface CfnProjectProps

LanguageType name
.NETAmazon.CDK.AWS.Evidently.CfnProjectProps
Javasoftware.amazon.awscdk.services.evidently.CfnProjectProps
Pythonaws_cdk.aws_evidently.CfnProjectProps
TypeScript @aws-cdk/aws-evidently » CfnProjectProps

Properties for defining a CfnProject.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as evidently from '@aws-cdk/aws-evidently';
const cfnProjectProps: evidently.CfnProjectProps = {
  name: 'name',

  // the properties below are optional
  appConfigResource: {
    applicationId: 'applicationId',
    environmentId: 'environmentId',
  },
  dataDelivery: {
    logGroup: 'logGroup',
    s3: {
      bucketName: 'bucketName',

      // the properties below are optional
      prefix: 'prefix',
    },
  },
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringThe name for the project.
appConfigResource?IResolvable | AppConfigResourceObjectPropertyUse this parameter if the project will use client-side evaluation powered by AWS AppConfig .
dataDelivery?IResolvable | DataDeliveryObjectPropertyA structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
description?stringAn optional description of the project.
tags?CfnTag[]Assigns one or more tags (key-value pairs) to the project.

name

Type: string

The name for the project.

It can include up to 127 characters.

appConfigResource?

Type: IResolvable | AppConfigResourceObjectProperty (optional)

Use this parameter if the project will use client-side evaluation powered by AWS AppConfig .

Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Use client-side evaluation - powered by AWS AppConfig .

This parameter is a structure that contains information about the AWS AppConfig application that will be used as for client-side evaluation.

To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.

dataDelivery?

Type: IResolvable | DataDeliveryObjectProperty (optional)

A structure 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.

You can't specify both CloudWatchLogs and S3Destination in the same operation.

description?

Type: string (optional)

An optional description of the project.

tags?

Type: CfnTag[] (optional)

Assigns one or more tags (key-value pairs) to the project.

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

For more information, see Tagging AWS resources .

← PreviousNext →