Package software.amazon.awscdk.services.evidently

Class CfnProject

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.738Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProject

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

    • CfnProject

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

    • CfnProject

      @Stability(Stable) public CfnProject(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the project.

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull public String getName()
      The name for the project.

      It can include up to 127 characters.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name for the project.

      It can include up to 127 characters.

    • getAppConfigResource

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setAppConfigResource(@Nullable 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

      @Stability(Stable) public void setAppConfigResource(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setDataDelivery(@Nullable 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

      @Stability(Stable) public void setDataDelivery(@Nullable 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

      @Stability(Stable) @Nullable public String getDescription()
      An optional description of the project.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description of the project.