Package software.amazon.awscdk.services.databrew

Interface CfnProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.062Z")
@Stability(Stable)
public interface CfnProjectProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProject.

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.*;
 CfnProjectProps cfnProjectProps = CfnProjectProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProjectProps.Builder	A builder for CfnProjectProps
static final class	CfnProjectProps.Jsii$Proxy	An implementation for CfnProjectProps

Method Summary

Modifier and Type	Method	Description
static CfnProjectProps.Builder	builder()
String	getDatasetName()	The dataset that the project is to act upon.
String	getName()	The unique name of a project.
String	getRecipeName()	The name of a recipe that will be developed during a project session.
String	getRoleArn()	The Amazon Resource Name (ARN) of the role that will be assumed for this project.
default Object	getSample()	The sample size and sampling type to apply to the data.
default List<CfnTag>	getTags()	Metadata tags that have been applied to the project.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetName

@Stability(Stable)
@NotNull
String getDatasetName()

The dataset that the project is to act upon.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-datasetname

getName

@Stability(Stable)
@NotNull
String getName()

The unique name of a project.

See Also:

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

getRecipeName

@Stability(Stable)
@NotNull
String getRecipeName()

The name of a recipe that will be developed during a project session.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-recipename

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the role that will be assumed for this project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-rolearn

getSample

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-project.html#cfn-databrew-project-sample

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata tags that have been applied to the project.

See Also:

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

builder

@Stability(Stable)
static CfnProjectProps.Builder builder()

Returns:

a CfnProjectProps.Builder of CfnProjectProps