Class CfnRuleset
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.databrew.CfnRuleset
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:55:55.837Z")
@Stability(Stable)
public class CfnRuleset
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnRuleset
.static interface
Selector of a column from a dataset for profile job configuration.static interface
Represents a single data quality requirement that should be validated in the scope of this dataset.static interface
A key-value pair to associate an expression's substitution variable names with their values.static interface
The threshold used with a non-aggregate check expression.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnRuleset
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnRuleset
(software.amazon.jsii.JsiiObjectRef objRef) CfnRuleset
(software.constructs.Construct scope, String id, CfnRulesetProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe description of the ruleset.getName()
The name of the ruleset.getRules()
Contains metadata about the ruleset.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of the ruleset.void
The name of the ruleset.void
Contains metadata about the ruleset.void
setRules
(IResolvable value) Contains metadata about the ruleset.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs to apply to this resource.void
setTargetArn
(String value) The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnRulesetProps props) - 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. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name of the ruleset. -
setName
The name of the ruleset. -
getRules
Contains metadata about the ruleset. -
setRules
Contains metadata about the ruleset. -
setRules
Contains metadata about the ruleset. -
getTargetArn
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. -
setTargetArn
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. -
getDescription
The description of the ruleset. -
setDescription
The description of the ruleset. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-