AWS::DataBrew::Ruleset - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DataBrew::Ruleset

Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataBrew::Ruleset",
  "Properties" : {
      "Description" : String,
      "Name" : String,
      "Rules" : [ Rule, ... ],
      "Tags" : [ Tag, ... ],
      "TargetArn" : String
    }
}

YAML

Type: AWS::DataBrew::Ruleset
Properties:
  Description: String
  Name: String
  Rules: 
    - Rule
  Tags: 
    - Tag
  TargetArn: String

Properties

Description

The description of the ruleset.

Required: No

Type: String

Maximum: 1024

Update requires: No interruption

Name

The name of the ruleset.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Rules

Contains metadata about the ruleset.

Required: Yes

Type: Array of Rule

Minimum: 1

Update requires: No interruption

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetArn

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

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example, { "Ref": "myRuleset" }.

For an AWS Glue DataBrew ruleset named myRuleset, Ref returns the name of the ruleset.