Package software.amazon.awscdk.services.databrew

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.databrew.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.119Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable
A CloudFormation AWS::DataBrew::Project.

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();

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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata tags that have been applied to the project.

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

      If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.

    • setSample

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

      If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.

    • setSample

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

      If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.