CfnRecipePropsMixin

class aws_cdk.mixins_preview.aws_databrew.mixins.CfnRecipePropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a new AWS Glue DataBrew transformation recipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-recipe.html
CloudformationResource:: AWS::DataBrew::Recipe
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

cfn_recipe_props_mixin = databrew_mixins.CfnRecipePropsMixin(databrew_mixins.CfnRecipeMixinProps(
    description="description",
    name="name",
    steps=[databrew_mixins.CfnRecipePropsMixin.RecipeStepProperty(
        action=databrew_mixins.CfnRecipePropsMixin.ActionProperty(
            operation="operation",
            parameters={
                "parameters_key": "parameters"
            }
        ),
        condition_expressions=[databrew_mixins.CfnRecipePropsMixin.ConditionExpressionProperty(
            condition="condition",
            target_column="targetColumn",
            value="value"
        )]
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DataBrew::Recipe.

Parameters:

props (Union[CfnRecipeMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'steps', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ActionProperty

class CfnRecipePropsMixin.ActionProperty(*, operation=None, parameters=None)

Bases: object

Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset.

Parameters:

operation (Optional[str]) – The name of a valid DataBrew transformation to be performed on the data.
parameters (Union[Mapping[str, str], IResolvable, None]) – Contextual parameters for the transformation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-action.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

action_property = databrew_mixins.CfnRecipePropsMixin.ActionProperty(
    operation="operation",
    parameters={
        "parameters_key": "parameters"
    }
)

Attributes

operation

The name of a valid DataBrew transformation to be performed on the data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-action.html#cfn-databrew-recipe-action-operation

parameters

Contextual parameters for the transformation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-action.html#cfn-databrew-recipe-action-parameters

ConditionExpressionProperty

class CfnRecipePropsMixin.ConditionExpressionProperty(*, condition=None, target_column=None, value=None)

Bases: object

Represents an individual condition that evaluates to true or false.

Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.

If a recipe requires more than one condition, then the recipe must specify multiple ConditionExpression elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.

Parameters:

condition (Optional[str]) – A specific condition to apply to a recipe action. For more information, see Recipe structure in the AWS Glue DataBrew Developer Guide .
target_column (Optional[str]) – A column to apply this condition to.
value (Optional[str]) – A value that the condition must evaluate to for the condition to succeed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

condition_expression_property = databrew_mixins.CfnRecipePropsMixin.ConditionExpressionProperty(
    condition="condition",
    target_column="targetColumn",
    value="value"
)

Attributes

condition

A specific condition to apply to a recipe action.

For more information, see Recipe structure in the AWS Glue DataBrew Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html#cfn-databrew-recipe-conditionexpression-condition

target_column

A column to apply this condition to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html#cfn-databrew-recipe-conditionexpression-targetcolumn

value

A value that the condition must evaluate to for the condition to succeed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-conditionexpression.html#cfn-databrew-recipe-conditionexpression-value

RecipeStepProperty

class CfnRecipePropsMixin.RecipeStepProperty(*, action=None, condition_expressions=None)

Bases: object

Represents a single step from a DataBrew recipe to be performed.

Parameters:

action (Union[IResolvable, ActionProperty, Dict[str, Any], None]) – The particular action to be performed in the recipe step.
condition_expressions (Union[IResolvable, Sequence[Union[IResolvable, ConditionExpressionProperty, Dict[str, Any]]], None]) – One or more conditions that must be met for the recipe step to succeed. .. epigraph:: All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipestep.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

recipe_step_property = databrew_mixins.CfnRecipePropsMixin.RecipeStepProperty(
    action=databrew_mixins.CfnRecipePropsMixin.ActionProperty(
        operation="operation",
        parameters={
            "parameters_key": "parameters"
        }
    ),
    condition_expressions=[databrew_mixins.CfnRecipePropsMixin.ConditionExpressionProperty(
        condition="condition",
        target_column="targetColumn",
        value="value"
    )]
)

Attributes

action

The particular action to be performed in the recipe step.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipestep.html#cfn-databrew-recipe-recipestep-action

condition_expressions

One or more conditions that must be met for the recipe step to succeed.

All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipestep.html#cfn-databrew-recipe-recipestep-conditionexpressions