AWS::Evidently::Project - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Evidently::Project

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Evidently::Project",
  "Properties" : {
      "AppConfigResource" : AppConfigResourceObject,
      "DataDelivery" : DataDeliveryObject,
      "Description" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Evidently::Project
Properties:
  AppConfigResource: 
    AppConfigResourceObject
  DataDelivery: 
    DataDeliveryObject
  Description: String
  Name: String
  Tags: 
    - Tag

Properties

AppConfigResource

Use this parameter if the project will use client-side evaluation powered by Amazon 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 Amazon AppConfig.

This parameter is a structure that contains information about the Amazon 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.

Required: No

Type: AppConfigResourceObject

Update requires: No interruption

DataDelivery

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.

Required: No

Type: DataDeliveryObject

Update requires: No interruption

Description

An optional description of the project.

Required: No

Type: String

Minimum: 0

Maximum: 160

Update requires: No interruption

Name

The name for the project. It can include up to 127 characters.

Required: Yes

Type: String

Pattern: [-a-zA-Z0-9._]*

Minimum: 1

Maximum: 127

Update requires: Replacement

Tags

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 Amazon and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a project.

For more information, see Tagging Amazon resources.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the project. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the project. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject