CfnProjectProps

class aws_cdk.aws_evidently.CfnProjectProps(*, name, app_config_resource=None, data_delivery=None, description=None, tags=None)

Bases: object

Properties for defining a CfnProject.

Parameters:
  • name (str) – The name for the project. It can include up to 127 characters.

  • app_config_resource (Union[IResolvable, AppConfigResourceObjectProperty, Dict[str, Any], None]) – 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.

  • data_delivery (Union[IResolvable, DataDeliveryObjectProperty, Dict[str, Any], None]) – 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 (Optional[str]) – An optional description of the project.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_evidently as evidently

cfn_project_props = evidently.CfnProjectProps(
    name="name",

    # the properties below are optional
    app_config_resource=evidently.CfnProject.AppConfigResourceObjectProperty(
        application_id="applicationId",
        environment_id="environmentId"
    ),
    data_delivery=evidently.CfnProject.DataDeliveryObjectProperty(
        log_group="logGroup",
        s3=evidently.CfnProject.S3DestinationProperty(
            bucket_name="bucketName",

            # the properties below are optional
            prefix="prefix"
        )
    ),
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

app_config_resource

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-appconfigresource

data_delivery

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-datadelivery

description

An optional description of the project.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-description

name

The name for the project.

It can include up to 127 characters.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-name

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-tags