software.amazon.awscdk.services.databrew

Class CfnProject

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.302Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProject(Construct scope, java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDatasetName() The dataset that the project is to act upon.
java.lang.String	getName() The unique name of a project.
java.lang.String	getRecipeName() The name of a recipe that will be developed during a project session.
java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of the role that will be assumed for this project.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDatasetName(java.lang.String value) The dataset that the project is to act upon.
void	setName(java.lang.String value) The unique name of a project.
void	setRecipeName(java.lang.String value) The name of a recipe that will be developed during a project session.
void	setRoleArn(java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnProject(Construct scope,
                  java.lang.String id,
                  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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Metadata tags that have been applied to the project.

getDatasetName

public java.lang.String getDatasetName()

The dataset that the project is to act upon.

setDatasetName

public void setDatasetName(java.lang.String value)

The dataset that the project is to act upon.

getName

public java.lang.String getName()

The unique name of a project.

setName

public void setName(java.lang.String value)

The unique name of a project.

getRecipeName

public java.lang.String getRecipeName()

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

setRecipeName

public void setRecipeName(java.lang.String value)

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

getRoleArn

public java.lang.String getRoleArn()

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

setRoleArn

public void setRoleArn(java.lang.String value)

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

getSample

public java.lang.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

public void setSample(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

public void setSample(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.