class DataQualityRuleset (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Glue.Alpha.DataQualityRuleset
Go	github.com/aws/aws-cdk-go/awscdkgluealpha/v2#DataQualityRuleset
Java	software.amazon.awscdk.services.glue.alpha.DataQualityRuleset
Python	aws_cdk.aws_glue_alpha.DataQualityRuleset
TypeScript (source)	@aws-cdk/aws-glue-alpha » DataQualityRuleset

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IDataQualityRuleset

A Glue Data Quality ruleset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as glue_alpha from '@aws-cdk/aws-glue-alpha';

declare const dataQualityTargetTable: glue_alpha.DataQualityTargetTable;
const dataQualityRuleset = new glue_alpha.DataQualityRuleset(this, 'MyDataQualityRuleset', {
  rulesetDqdl: 'rulesetDqdl',
  targetTable: dataQualityTargetTable,

  // the properties below are optional
  clientToken: 'clientToken',
  description: 'description',
  rulesetName: 'rulesetName',
  tags: {
    tagsKey: 'tags',
  },
});

Initializer

new DataQualityRuleset(scope: Construct, id: string, props: DataQualityRulesetProps)

Parameters

• scope Construct
• id string
• props DataQualityRulesetProps

Construct Props

Name	Type	Description
rulesetDqdl🔹	string	The dqdl of the ruleset.
targetTable🔹	DataQualityTargetTable	The target table of the ruleset.
clientToken?🔹	string	The client token of the ruleset.
description?🔹	string	The description of the ruleset.
rulesetName?🔹	string	The name of the ruleset.
tags?🔹	{ [string]: string }	Key-Value pairs that define tags for the ruleset.

---

rulesetDqdl🔹

Type: string

The dqdl of the ruleset.

---

targetTable🔹

Type: DataQualityTargetTable

The target table of the ruleset.

---

clientToken?🔹

Type: string (optional)

The client token of the ruleset.

---

description?🔹

Type: string (optional)

The description of the ruleset.

---

rulesetName?🔹

Type: string (optional, default: cloudformation generated name)

The name of the ruleset.

---

tags?🔹

Type: { [string]: string } (optional, default: empty tags)

Key-Value pairs that define tags for the ruleset.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
rulesetArn🔹	string	ARN of this ruleset.
rulesetName🔹	string	Name of this ruleset.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

rulesetArn🔹

Type: string

ARN of this ruleset.

---

rulesetName🔹

Type: string

Name of this ruleset.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromRulesetArn(scope, id, rulesetArn)🔹
static fromRulesetName(scope, id, rulesetName)🔹

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromRulesetArn(scope, id, rulesetArn)🔹

public static fromRulesetArn(scope: Construct, id: string, rulesetArn: string): IDataQualityRuleset

Parameters

• scope Construct
• id string
• rulesetArn string

Returns

• IDataQualityRuleset

---

static fromRulesetName(scope, id, rulesetName)🔹

public static fromRulesetName(scope: Construct, id: string, rulesetName: string): IDataQualityRuleset

Parameters

• scope Construct
• id string
• rulesetName string

Returns

• IDataQualityRuleset