Package software.amazon.awscdk.services.databrew

Class CfnRuleset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.databrew.CfnRuleset
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.131Z") @Stability(Stable) public class CfnRuleset extends CfnResource implements IInspectable
A CloudFormation AWS::DataBrew::Ruleset.

Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset.

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.databrew.*;
 CfnRuleset cfnRuleset = CfnRuleset.Builder.create(this, "MyCfnRuleset")
         .name("name")
         .rules(List.of(RuleProperty.builder()
                 .checkExpression("checkExpression")
                 .name("name")
                 // the properties below are optional
                 .columnSelectors(List.of(ColumnSelectorProperty.builder()
                         .name("name")
                         .regex("regex")
                         .build()))
                 .disabled(false)
                 .substitutionMap(List.of(SubstitutionValueProperty.builder()
                         .value("value")
                         .valueReference("valueReference")
                         .build()))
                 .threshold(ThresholdProperty.builder()
                         .value(123)
                         // the properties below are optional
                         .type("type")
                         .unit("unit")
                         .build())
                 .build()))
         .targetArn("targetArn")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnRuleset

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

    • CfnRuleset

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

    • CfnRuleset

      @Stability(Stable) public CfnRuleset(@NotNull Construct scope, @NotNull String id, @NotNull CfnRulesetProps props)
      Create a new AWS::DataBrew::Ruleset.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the ruleset.

    • setName

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

    • getRules

      @Stability(Stable) @NotNull public Object getRules()
      Contains metadata about the ruleset.

    • setRules

      @Stability(Stable) public void setRules(@NotNull IResolvable value)
      Contains metadata about the ruleset.

    • setRules

      @Stability(Stable) public void setRules(@NotNull List<Object> value)
      Contains metadata about the ruleset.

    • getTargetArn

      @Stability(Stable) @NotNull public String getTargetArn()
      The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

    • setTargetArn

      @Stability(Stable) public void setTargetArn(@NotNull String value)
      The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the ruleset.

    • setDescription

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