Package software.amazon.awscdk.services.evidently

Class CfnProject

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.evidently.CfnProject
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:07.528Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnProjectProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

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

    • setName

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

    • getAppConfigResource

      @Stability(Stable) @Nullable public Object getAppConfigResource()
      Use this parameter if the project will use client-side evaluation powered by AWS AppConfig .

    • setAppConfigResource

      @Stability(Stable) public void setAppConfigResource(@Nullable IResolvable value)
      Use this parameter if the project will use client-side evaluation powered by AWS AppConfig .

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

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

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

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

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Assigns one or more tags (key-value pairs) to the project.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Assigns one or more tags (key-value pairs) to the project.