Package software.amazon.awscdk.services.databrew

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.databrew.CfnProject
All Implemented Interfaces:
IInspectable, IProjectRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:07.957Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable, IProjectRef, ITaggable
Specifies a new AWS Glue DataBrew project.

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.databrew.*;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .datasetName("datasetName")
         .name("name")
         .recipeName("recipeName")
         .roleArn("roleArn")
         // the properties below are optional
         .sample(SampleProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .size(123)
                 .build())
         .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)
      Create a new AWS::DataBrew::Project.

      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

    • isCfnProject

      @Stability(Stable) @NotNull public static Boolean isCfnProject(@NotNull Object x)
      Checks whether the given object is a CfnProject.

      Parameters:
      x - This parameter is required.

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

    • getCfnProperties

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

    • getProjectRef

      @Stability(Stable) @NotNull public ProjectReference getProjectRef()
      A reference to a Project resource.
      Specified by:
      getProjectRef in interface IProjectRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDatasetName

      @Stability(Stable) @NotNull public String getDatasetName()
      The dataset that the project is to act upon.

    • setDatasetName

      @Stability(Stable) public void setDatasetName(@NotNull String value)
      The dataset that the project is to act upon.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The unique name of a project.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique name of a project.

    • getRecipeName

      @Stability(Stable) @NotNull public String getRecipeName()
      The name of a recipe that will be developed during a project session.

    • setRecipeName

      @Stability(Stable) public void setRecipeName(@NotNull String value)
      The name of a recipe that will be developed during a project session.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the role that will be assumed for this project.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the role that will be assumed for this project.

    • getSample

      @Stability(Stable) @Nullable public Object getSample()
      The sample size and sampling type to apply to the data.

      Returns union: either IResolvable or CfnProject.SampleProperty

    • setSample

      @Stability(Stable) public void setSample(@Nullable IResolvable value)
      The sample size and sampling type to apply to the data.

    • setSample

      @Stability(Stable) public void setSample(@Nullable CfnProject.SampleProperty value)
      The sample size and sampling type to apply to the data.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata tags that have been applied to the project.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata tags that have been applied to the project.