CfnRulesetProps

class aws_cdk.aws_databrew.CfnRulesetProps(*, name, rules, target_arn, description=None, tags=None)

Bases: object

Properties for defining a CfnRuleset.

Parameters:
  • name (str) – The name of the ruleset.

  • rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]]]) – Contains metadata about the ruleset.

  • target_arn (str) – The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

  • description (Optional[str]) – The description of the ruleset.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.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 import aws_databrew as databrew

cfn_ruleset_props = databrew.CfnRulesetProps(
    name="name",
    rules=[databrew.CfnRuleset.RuleProperty(
        check_expression="checkExpression",
        name="name",

        # the properties below are optional
        column_selectors=[databrew.CfnRuleset.ColumnSelectorProperty(
            name="name",
            regex="regex"
        )],
        disabled=False,
        substitution_map=[databrew.CfnRuleset.SubstitutionValueProperty(
            value="value",
            value_reference="valueReference"
        )],
        threshold=databrew.CfnRuleset.ThresholdProperty(
            value=123,

            # the properties below are optional
            type="type",
            unit="unit"
        )
    )],
    target_arn="targetArn",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the ruleset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-description

name

The name of the ruleset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-name

rules

Contains metadata about the ruleset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-rules

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-tags

target_arn

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-targetarn