Package software.amazon.awscdk.services.databrew

Class CfnRecipe

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.CfnRecipe
All Implemented Interfaces:
IInspectable, IRecipeRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:33.860Z") @Stability(Stable) public class CfnRecipe extends CfnResource implements IInspectable, IRecipeRef, ITaggable
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();

See Also:

  • 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

    • CfnRecipe

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

    • CfnRecipe

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

    • CfnRecipe

      @Stability(Stable) public CfnRecipe(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRecipeProps props)
      Create a new AWS::DataBrew::Recipe.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnRecipe

      @Stability(Stable) @NotNull public static Boolean isCfnRecipe(@NotNull Object x)
      Checks whether the given object is a CfnRecipe.

      Parameters:
      x - This parameter is required.

    • 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

    • getRecipeRef

      @Stability(Stable) @NotNull public RecipeReference getRecipeRef()
      A reference to a Recipe resource.
      Specified by:
      getRecipeRef in interface IRecipeRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The unique name for the recipe.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique name for the recipe.

    • getSteps

      @Stability(Stable) @NotNull public Object getSteps()
      A list of steps that are defined by the recipe.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRecipe.RecipeStepProperty>

    • setSteps

      @Stability(Stable) public void setSteps(@NotNull IResolvable value)
      A list of steps that are defined by the recipe.

    • setSteps

      @Stability(Stable) public void setSteps(@NotNull List<Object> value)
      A list of steps that are defined by the recipe.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the recipe.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the recipe.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata tags that have been applied to the recipe.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata tags that have been applied to the recipe.