Package software.amazon.awscdk.services.glue

Class CfnDataQualityRuleset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnDataQualityRuleset
All Implemented Interfaces:
IInspectable, IDataQualityRulesetRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.477Z") @Stability(Stable) public class CfnDataQualityRuleset extends CfnResource implements IInspectable, IDataQualityRulesetRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object tags;
 CfnDataQualityRuleset cfnDataQualityRuleset = CfnDataQualityRuleset.Builder.create(this, "MyCfnDataQualityRuleset")
         .clientToken("clientToken")
         .description("description")
         .name("name")
         .ruleset("ruleset")
         .tags(tags)
         .targetTable(DataQualityTargetTableProperty.builder()
                 .databaseName("databaseName")
                 .tableName("tableName")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataQualityRuleset

      protected CfnDataQualityRuleset(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataQualityRuleset

      protected CfnDataQualityRuleset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataQualityRuleset

      @Stability(Stable) public CfnDataQualityRuleset(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDataQualityRulesetProps props)
      Create a new AWS::Glue::DataQualityRuleset.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDataQualityRuleset

      @Stability(Stable) public CfnDataQualityRuleset(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Glue::DataQualityRuleset.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • isCfnDataQualityRuleset

      @Stability(Stable) @NotNull public static Boolean isCfnDataQualityRuleset(@NotNull Object x)
      Checks whether the given object is a CfnDataQualityRuleset.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataQualityRulesetRef

      @Stability(Stable) @NotNull public DataQualityRulesetReference getDataQualityRulesetRef()
      A reference to a DataQualityRuleset resource.
      Specified by:
      getDataQualityRulesetRef in interface IDataQualityRulesetRef

    • getClientToken

      @Stability(Stable) @Nullable public String getClientToken()
      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.

    • setClientToken

      @Stability(Stable) public void setClientToken(@Nullable String value)
      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the data quality ruleset.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the data quality ruleset.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the data quality ruleset.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the data quality ruleset.

    • getRuleset

      @Stability(Stable) @Nullable public String getRuleset()
      A Data Quality Definition Language (DQDL) ruleset.

    • setRuleset

      @Stability(Stable) public void setRuleset(@Nullable String value)
      A Data Quality Definition Language (DQDL) ruleset.

    • getTags

      @Stability(Stable) @Nullable public Object getTags()
      A list of tags applied to the data quality ruleset.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Object value)
      A list of tags applied to the data quality ruleset.

    • getTargetTable

      @Stability(Stable) @Nullable public Object getTargetTable()
      An object representing an AWS Glue table.

      Returns union: either IResolvable or CfnDataQualityRuleset.DataQualityTargetTableProperty

    • setTargetTable

      @Stability(Stable) public void setTargetTable(@Nullable IResolvable value)
      An object representing an AWS Glue table.

    • setTargetTable

      @Stability(Stable) public void setTargetTable(@Nullable CfnDataQualityRuleset.DataQualityTargetTableProperty value)
      An object representing an AWS Glue table.