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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.830Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnProject.Builder A fluent builder for CfnProject.
static interface	CfnProject.SampleProperty Represents the sample size and sampling type for DataBrew to use for interactive data analysis.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProject(software.constructs.Construct scope, String id, CfnProjectProps props) Create a new `AWS::DataBrew::Project`.
protected	CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
Object	getSample() The sample size and sampling type to apply to the data.
TagManager	getTags() Metadata tags that have been applied to the project.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatasetName(String value) The dataset that the project is to act upon.
void	setName(String value) The unique name of a project.
void	setRecipeName(String value) The name of a recipe that will be developed during a project session.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of the role that will be assumed for this project.
void	setSample(CfnProject.SampleProperty value) The sample size and sampling type to apply to the data.
void	setSample(IResolvable value) The sample size and sampling type to apply to the data.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProject

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

CfnProject

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

CfnProject

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata tags that have been applied to the project.

getDatasetName

@Stability(value=Stable)
 @NotNull
public String getDatasetName()

The dataset that the project is to act upon.

setDatasetName

@Stability(value=Stable)
public void setDatasetName(@NotNull
                                                    String value)

The dataset that the project is to act upon.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The unique name of a project.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The unique name of a project.

getRecipeName

@Stability(value=Stable)
 @NotNull
public String getRecipeName()

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

setRecipeName

@Stability(value=Stable)
public void setRecipeName(@NotNull
                                                   String value)

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

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

getSample

@Stability(value=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(value=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.

setSample

@Stability(value=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.