Package software.amazon.awscdk.services.databrew

Interface CfnRulesetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRulesetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:06.017Z")
@Stability(Stable)
public interface CfnRulesetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRuleset.

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.*;
 CfnRulesetProps cfnRulesetProps = CfnRulesetProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRulesetProps.Builder	A builder for CfnRulesetProps
static final class	CfnRulesetProps.Jsii$Proxy	An implementation for CfnRulesetProps

Method Summary

Modifier and Type	Method	Description
static CfnRulesetProps.Builder	builder()
default String	getDescription()	The description of the ruleset.
String	getName()	The name of the ruleset.
Object	getRules()	Contains metadata about the ruleset.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getTargetArn()	The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the ruleset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-name

getRules

@Stability(Stable)
@NotNull
Object getRules()

Contains metadata about the ruleset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-rules

getTargetArn

@Stability(Stable)
@NotNull
String getTargetArn()

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-targetarn

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the ruleset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-description

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html#cfn-databrew-ruleset-tags

builder

@Stability(Stable)
static CfnRulesetProps.Builder builder()

Returns:

a CfnRulesetProps.Builder of CfnRulesetProps