software.amazon.awscdk.services.evidently

Class CfnProject

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.evidently.CfnProject

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.756Z")
public class CfnProject
extends CfnResource
implements IInspectable

A CloudFormation `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.

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.*;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .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	Class and Description
static interface	CfnProject.AppConfigResourceObjectProperty This is a structure that defines the configuration of how your application integrates with AWS AppConfig to run client-side evaluation.
static class	CfnProject.Builder A fluent builder for CfnProject.
static interface	CfnProject.DataDeliveryObjectProperty A structure that contains information about where Evidently is to store evaluation events for longer term storage.
static interface	CfnProject.S3DestinationProperty If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProject(Construct scope, java.lang.String id, CfnProjectProps props) Create a new `AWS::Evidently::Project`.
protected	CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAppConfigResource() Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
java.lang.String	getAttrArn() The ARN of the project.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.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.
java.lang.String	getDescription() An optional description of the project.
java.lang.String	getName() The name for the project.
TagManager	getTags() Assigns one or more tags (key-value pairs) to the project.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAppConfigResource(CfnProject.AppConfigResourceObjectProperty value) Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
void	setAppConfigResource(IResolvable value) Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
void	setDataDelivery(CfnProject.DataDeliveryObjectProperty value) A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
void	setDataDelivery(IResolvable value) A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
void	setDescription(java.lang.String value) An optional description of the project.
void	setName(java.lang.String value) The name for the project.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProject

protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

CfnProject

protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnProject

public CfnProject(Construct scope,
                  java.lang.String id,
                  CfnProjectProps props)

Create a new `AWS::Evidently::Project`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the project.

For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager 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 .

getName

public java.lang.String getName()

The name for the project.

It can include up to 127 characters.

setName

public void setName(java.lang.String value)

The name for the project.

It can include up to 127 characters.

getAppConfigResource

public java.lang.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.

setAppConfigResource

public void setAppConfigResource(IResolvable value)

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.

setAppConfigResource

public void setAppConfigResource(CfnProject.AppConfigResourceObjectProperty value)

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

public java.lang.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.

setDataDelivery

public void setDataDelivery(IResolvable value)

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.

setDataDelivery

public void setDataDelivery(CfnProject.DataDeliveryObjectProperty value)

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

public java.lang.String getDescription()

An optional description of the project.

setDescription

public void setDescription(java.lang.String value)

An optional description of the project.