software.amazon.awscdk.services.databrew

Class CfnRecipe

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.719Z")
public class CfnRecipe
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataBrew::Recipe`.

Specifies a new AWS Glue DataBrew transformation recipe.

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.*;
 CfnRecipe cfnRecipe = CfnRecipe.Builder.create(this, "MyCfnRecipe")
         .name("name")
         .steps(List.of(RecipeStepProperty.builder()
                 .action(ActionProperty.builder()
                         .operation("operation")
                         // the properties below are optional
                         .parameters(Map.of(
                                 "parametersKey", "parameters"))
                         .build())
                 // the properties below are optional
                 .conditionExpressions(List.of(ConditionExpressionProperty.builder()
                         .condition("condition")
                         .targetColumn("targetColumn")
                         // the properties below are optional
                         .value("value")
                         .build()))
                 .build()))
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnRecipe.ActionProperty Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset.
static class	CfnRecipe.Builder A fluent builder for CfnRecipe.
static interface	CfnRecipe.ConditionExpressionProperty Represents an individual condition that evaluates to true or false.
static interface	CfnRecipe.DataCatalogInputDefinitionProperty Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.
static interface	CfnRecipe.InputProperty Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.
static interface	CfnRecipe.RecipeParametersProperty Parameters that are used as inputs for various recipe actions.
static interface	CfnRecipe.RecipeStepProperty Represents a single step from a DataBrew recipe to be performed.
static interface	CfnRecipe.S3LocationProperty Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
static interface	CfnRecipe.SecondaryInputProperty Represents secondary inputs in a UNION transform.

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
	CfnRecipe(Construct scope, java.lang.String id, CfnRecipeProps props) Create a new `AWS::DataBrew::Recipe`.
protected	CfnRecipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRecipe(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	getDescription() The description of the recipe.
java.lang.String	getName() The unique name for the recipe.
java.lang.Object	getSteps() A list of steps that are defined by the recipe.
TagManager	getTags() Metadata tags that have been applied to the recipe.
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	setDescription(java.lang.String value) The description of the recipe.
void	setName(java.lang.String value) The unique name for the recipe.
void	setSteps(IResolvable value) A list of steps that are defined by the recipe.
void	setSteps(java.util.List<java.lang.Object> value) A list of steps that are defined by the recipe.

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

CfnRecipe

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

CfnRecipe

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

CfnRecipe

public CfnRecipe(Construct scope,
                 java.lang.String id,
                 CfnRecipeProps props)

Create a new `AWS::DataBrew::Recipe`.

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

getName

public java.lang.String getName()

The unique name for the recipe.

setName

public void setName(java.lang.String value)

The unique name for the recipe.

getSteps

public java.lang.Object getSteps()

A list of steps that are defined by the recipe.

setSteps

public void setSteps(IResolvable value)

A list of steps that are defined by the recipe.

setSteps

public void setSteps(java.util.List<java.lang.Object> value)

A list of steps that are defined by the recipe.

getDescription

public java.lang.String getDescription()

The description of the recipe.

setDescription

public void setDescription(java.lang.String value)

The description of the recipe.