2.270.0

class DataQualityRuleset (construct) ⚠️

LanguageType name
.NETAmazon.CDK.AWS.Glue.Alpha.DataQualityRuleset
Gogithub.com/aws/aws-cdk-go/awscdkgluealpha/v2#DataQualityRuleset
Javasoftware.amazon.awscdk.services.glue.alpha.DataQualityRuleset
Pythonaws_cdk.aws_glue_alpha.DataQualityRuleset
TypeScript (source)@aws-cdk/aws-glue-alpha » DataQualityRuleset

⚠️ Deprecated: undefined

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IDataQualityRuleset

A Glue Data Quality ruleset.

Example

declare const database: glue.IDatabase;
new glue.DataQualityRuleset(this, 'MyRuleset', {
  rulesetName: 'my_ruleset',
  dqdl: glue.Dqdl.fromString('Rules = [ RowCount > 100, IsComplete "order_id" ]'),
  targetTable: glue.DataQualityTargetTable.fromTableName(database, 'my_table'),
});

Initializer

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

⚠️ Deprecated: undefined

Parameters

Construct Props

NameTypeDescription
dqdl⚠️DqdlThe DQDL document defining the ruleset's data quality rules.
rulesetName⚠️stringThe name of the ruleset.
targetTable⚠️DataQualityTargetTableThe target table of the ruleset.
description?⚠️stringThe description of the ruleset.
removalPolicy?⚠️RemovalPolicyPolicy to apply when the ruleset is removed from the stack.
tags?⚠️{ [string]: string }Key-Value pairs that define tags for the ruleset.

dqdl⚠️

⚠️ Deprecated: undefined

Type: Dqdl

The DQDL document defining the ruleset's data quality rules.

Build it with Dqdl.fromString(...).

rulesetName⚠️

⚠️ Deprecated: undefined

Type: string

The name of the ruleset.

targetTable⚠️

⚠️ Deprecated: undefined

Type: DataQualityTargetTable

The target table of the ruleset.

description?⚠️

⚠️ Deprecated: undefined

Type: string (optional)

The description of the ruleset.

removalPolicy?⚠️

⚠️ Deprecated: undefined

Type: RemovalPolicy (optional, default: resource will be destroyed)

Policy to apply when the ruleset is removed from the stack.

tags?⚠️

⚠️ Deprecated: undefined

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

Key-Value pairs that define tags for the ruleset.

Properties

NameTypeDescription
env⚠️ResourceEnvironmentThe environment this resource belongs to.
node⚠️NodeThe tree node.
rulesetArn⚠️stringARN of this ruleset.
rulesetName⚠️stringName of this ruleset.
stack⚠️StackThe stack in which this resource is defined.
static PROPERTY_INJECTION_ID⚠️stringUniquely identifies this class.

env⚠️

⚠️ Deprecated: undefined

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⚠️

⚠️ Deprecated: undefined

Type: Node

The tree node.

rulesetArn⚠️

⚠️ Deprecated: undefined

Type: string

ARN of this ruleset.

rulesetName⚠️

⚠️ Deprecated: undefined

Type: string

Name of this ruleset.

stack⚠️

⚠️ Deprecated: undefined

Type: Stack

The stack in which this resource is defined.

static PROPERTY_INJECTION_ID⚠️

⚠️ Deprecated: undefined

Type: string

Uniquely identifies this class.

Methods

NameDescription
applyCrossStackReferenceStrength(strength)⚠️Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)⚠️Apply the given removal policy to this resource.
toString()⚠️Returns a string representation of this construct.
with(...mixins)⚠️Applies one or more mixins to this construct.
static fromRulesetArn(scope, id, rulesetArn)⚠️
static fromRulesetName(scope, id, rulesetName)⚠️

applyCrossStackReferenceStrength(strength)⚠️

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

⚠️ Deprecated: undefined

Parameters

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

applyRemovalPolicy(policy)⚠️

public applyRemovalPolicy(policy: RemovalPolicy): void

⚠️ Deprecated: undefined

Parameters

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

⚠️ Deprecated: undefined

Returns

  • string

Returns a string representation of this construct.

with(...mixins)⚠️

public with(...mixins: IMixin[]): IConstruct

⚠️ Deprecated: undefined

Parameters

Returns

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

static fromRulesetArn(scope, id, rulesetArn)⚠️

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

⚠️ Deprecated: undefined

Parameters

  • scope Construct
  • id string
  • rulesetArn string

Returns

static fromRulesetName(scope, id, rulesetName)⚠️

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

⚠️ Deprecated: undefined

Parameters

  • scope Construct
  • id string
  • rulesetName string

Returns

← PreviousNext →