AWS::Glue::DataQualityRuleset

The AWS::Glue::DataQualityRuleset resource specifies a data quality ruleset with DQDL rules applied to a specified AWS Glue table. For more information, see AWS Glue Data Quality in the AWS Glue Developer Guide.

Syntax

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

JSON

{
  "Type" : "AWS::Glue::DataQualityRuleset",
  "Properties" : {
      "ClientToken" : String,
      "Description" : String,
      "Name" : String,
      "Ruleset" : String,
      "Tags" : [ Tag, ... ],
      "TargetTable" : DataQualityTargetTable
    }
}

YAML

Type: AWS::Glue::DataQualityRuleset
Properties:
  ClientToken: String
  Description: String
  Name: String
  Ruleset: String
  Tags: 
    - Tag
  TargetTable: 
    DataQualityTargetTable

Properties

ClientToken

Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.

Required: No

Type: String

Update requires: No interruption

Description

A description of the data quality ruleset.

Required: No

Type: String

Update requires: No interruption

Name

The name of the data quality ruleset.

Required: No

Type: String

Update requires: No interruption

Ruleset

A Data Quality Definition Language (DQDL) ruleset. For more information see the AWS Glue Developer Guide.

Required: No

Type: String

Update requires: No interruption

Tags

A list of tags applied to the data quality ruleset.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetTable

An object representing an AWS Glue table.

Required: No

Type: DataQualityTargetTable

Update requires: No interruption

Return values

Ref

Fn::GetAtt