@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.726Z") public class CfnRuleset extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnRuleset.Builder
A fluent builder for
CfnRuleset . |
static interface |
CfnRuleset.ColumnSelectorProperty
Selector of a column from a dataset for profile job configuration.
|
static interface |
CfnRuleset.RuleProperty
Represents a single data quality requirement that should be validated in the scope of this dataset.
|
static interface |
CfnRuleset.SubstitutionValueProperty
A key-value pair to associate an expression's substitution variable names with their values.
|
static interface |
CfnRuleset.ThresholdProperty
The threshold used with a non-aggregate check expression.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnRuleset(Construct scope,
java.lang.String id,
CfnRulesetProps props)
Create a new `AWS::DataBrew::Ruleset`.
|
protected |
CfnRuleset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnRuleset(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
The description of the ruleset.
|
java.lang.String |
getName()
The name of the ruleset.
|
java.lang.Object |
getRules()
Contains metadata about the ruleset.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getTargetArn()
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.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
The description of the ruleset.
|
void |
setName(java.lang.String value)
The name of the ruleset.
|
void |
setRules(IResolvable value)
Contains metadata about the ruleset.
|
void |
setRules(java.util.List<java.lang.Object> value)
Contains metadata about the ruleset.
|
void |
setTargetArn(java.lang.String value)
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnRuleset(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnRuleset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnRuleset(Construct scope, java.lang.String id, CfnRulesetProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getRules()
public void setRules(IResolvable value)
public void setRules(java.util.List<java.lang.Object> value)
public java.lang.String getTargetArn()
public void setTargetArn(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)