software.amazon.awscdk.services.evidently

Interface CfnProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:34.931Z")
 @Stability(value=Stable)
public interface CfnProjectProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.evidently.*;
 CfnProjectProps cfnProjectProps = CfnProjectProps.builder()
         .name("name")
         // the properties below are optional
         .appConfigResource(AppConfigResourceObjectProperty.builder()
                 .applicationId("applicationId")
                 .environmentId("environmentId")
                 .build())
         .dataDelivery(DataDeliveryObjectProperty.builder()
                 .logGroup("logGroup")
                 .s3(S3DestinationProperty.builder()
                         .bucketName("bucketName")
                         // the properties below are optional
                         .prefix("prefix")
                         .build())
                 .build())
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnProjectProps.Builder A builder for CfnProjectProps
static class	CfnProjectProps.Jsii$Proxy An implementation for CfnProjectProps

Method Summary

Modifier and Type	Method and Description
static CfnProjectProps.Builder	builder()
default Object	getAppConfigResource() Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
default Object	getDataDelivery() A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
default String	getDescription() An optional description of the project.
String	getName() The name for the project.
default List<CfnTag>	getTags() Assigns one or more tags (key-value pairs) to the project.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name for the project.

It can include up to 127 characters.

getAppConfigResource

@Stability(value=Stable)
 @Nullable
default Object getAppConfigResource()

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.

getDataDelivery

@Stability(value=Stable)
 @Nullable
default Object getDataDelivery()

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.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

An optional description of the project.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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 .

builder

@Stability(value=Stable)
static CfnProjectProps.Builder builder()

Returns:

a CfnProjectProps.Builder of CfnProjectProps