interface CfnRulesetProps

Language	Type name
.NET	Amazon.CDK.AWS.DataBrew.CfnRulesetProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdatabrew#CfnRulesetProps
Java	software.amazon.awscdk.services.databrew.CfnRulesetProps
Python	aws_cdk.aws_databrew.CfnRulesetProps
TypeScript	aws-cdk-lib » aws_databrew » CfnRulesetProps

Properties for defining a CfnRuleset.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_databrew as databrew } from 'aws-cdk-lib';
const cfnRulesetProps: databrew.CfnRulesetProps = {
  name: 'name',
  rules: [{
    checkExpression: 'checkExpression',
    name: 'name',

    // the properties below are optional
    columnSelectors: [{
      name: 'name',
      regex: 'regex',
    }],
    disabled: false,
    substitutionMap: [{
      value: 'value',
      valueReference: 'valueReference',
    }],
    threshold: {
      value: 123,

      // the properties below are optional
      type: 'type',
      unit: 'unit',
    },
  }],
  targetArn: 'targetArn',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	string	The name of the ruleset.
rules	IResolvable | IResolvable | RuleProperty[]	Contains metadata about the ruleset.
targetArn	string	The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
description?	string	The description of the ruleset.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

name

Type: string

The name of the ruleset.

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

---

rules

Type: IResolvable | IResolvable | RuleProperty[]

Contains metadata about the ruleset.

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

---

targetArn

Type: string

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

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

---

description?

Type: string (optional)

The description of the ruleset.

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

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

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