class DataQualityRuleset (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Glue.Alpha.DataQualityRuleset |
![]() | github.com/aws/aws-cdk-go/awscdkgluealpha/v2#DataQualityRuleset |
![]() | software.amazon.awscdk.services.glue.alpha.DataQualityRuleset |
![]() | aws_cdk.aws_glue_alpha.DataQualityRuleset |
![]() | @aws-cdk/aws-glue-alpha ยป DataQualityRuleset |
Implements
IConstruct
, IDependable
, IResource
, IData
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
Data
Quality Ruleset Props
Construct Props
Name | Type | Description |
---|---|---|
ruleset | string | The dqdl of the ruleset. |
target | Data | The target table of the ruleset. |
client | string | The client token of the ruleset. |
description? | string | The description of the ruleset. |
ruleset | 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:
Data
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 | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
ruleset | string | ARN of this ruleset. |
ruleset | string | Name of this ruleset. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | |
static from |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
static fromRulesetName(scope, id, rulesetName)
public static fromRulesetName(scope: Construct, id: string, rulesetName: string): IDataQualityRuleset
Parameters
- scope
Construct
- id
string
- rulesetName
string
Returns