AWS Native is in preview. AWS Classic is fully supported.
aws-native.databrew.Ruleset
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource schema for AWS::DataBrew::Ruleset.
Create Ruleset Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Ruleset(name: string, args: RulesetArgs, opts?: CustomResourceOptions);
@overload
def Ruleset(resource_name: str,
args: RulesetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Ruleset(resource_name: str,
opts: Optional[ResourceOptions] = None,
rules: Optional[Sequence[RulesetRuleArgs]] = None,
target_arn: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewRuleset(ctx *Context, name string, args RulesetArgs, opts ...ResourceOption) (*Ruleset, error)
public Ruleset(string name, RulesetArgs args, CustomResourceOptions? opts = null)
public Ruleset(String name, RulesetArgs args)
public Ruleset(String name, RulesetArgs args, CustomResourceOptions options)
type: aws-native:databrew:Ruleset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RulesetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RulesetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RulesetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RulesetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RulesetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const rulesetResource = new aws_native.databrew.Ruleset("rulesetResource", {
rules: [{
checkExpression: "string",
name: "string",
columnSelectors: [{
name: "string",
regex: "string",
}],
disabled: false,
substitutionMap: [{
value: "string",
valueReference: "string",
}],
threshold: {
value: 0,
type: aws_native.databrew.RulesetThresholdType.GreaterThanOrEqual,
unit: aws_native.databrew.RulesetThresholdUnit.Count,
},
}],
targetArn: "string",
description: "string",
name: "string",
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
Ruleset Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Ruleset resource accepts the following input properties:
- Rules
List<Pulumi.
Aws Native. Data Brew. Inputs. Ruleset Rule> - List of the data quality rules in the ruleset
- Target
Arn string - Arn of the target resource (dataset) to apply the ruleset to
- Description string
- Description of the Ruleset
- Name string
- Name of the Ruleset
- List<Pulumi.
Aws Native. Inputs. Tag>
- Rules
[]Ruleset
Rule Args - List of the data quality rules in the ruleset
- Target
Arn string - Arn of the target resource (dataset) to apply the ruleset to
- Description string
- Description of the Ruleset
- Name string
- Name of the Ruleset
- Tag
Args
- rules
List<Ruleset
Rule> - List of the data quality rules in the ruleset
- target
Arn String - Arn of the target resource (dataset) to apply the ruleset to
- description String
- Description of the Ruleset
- name String
- Name of the Ruleset
- List<Tag>
- rules
Ruleset
Rule[] - List of the data quality rules in the ruleset
- target
Arn string - Arn of the target resource (dataset) to apply the ruleset to
- description string
- Description of the Ruleset
- name string
- Name of the Ruleset
- Tag[]
- rules
Sequence[Ruleset
Rule Args] - List of the data quality rules in the ruleset
- target_
arn str - Arn of the target resource (dataset) to apply the ruleset to
- description str
- Description of the Ruleset
- name str
- Name of the Ruleset
- Sequence[Tag
Args]
- rules List<Property Map>
- List of the data quality rules in the ruleset
- target
Arn String - Arn of the target resource (dataset) to apply the ruleset to
- description String
- Description of the Ruleset
- name String
- Name of the Ruleset
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Ruleset resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
RulesetColumnSelector, RulesetColumnSelectorArgs
RulesetRule, RulesetRuleArgs
- Check
Expression string - Name string
- Name of the rule
- Column
Selectors []RulesetColumn Selector - Disabled bool
- Substitution
Map []RulesetSubstitution Value - Threshold
Ruleset
Threshold
- check
Expression String - name String
- Name of the rule
- column
Selectors List<RulesetColumn Selector> - disabled Boolean
- substitution
Map List<RulesetSubstitution Value> - threshold
Ruleset
Threshold
- check
Expression string - name string
- Name of the rule
- column
Selectors RulesetColumn Selector[] - disabled boolean
- substitution
Map RulesetSubstitution Value[] - threshold
Ruleset
Threshold
- check
Expression String - name String
- Name of the rule
- column
Selectors List<Property Map> - disabled Boolean
- substitution
Map List<Property Map> - threshold Property Map
RulesetSubstitutionValue, RulesetSubstitutionValueArgs
- Value string
- Value or column name
- Value
Reference string - Variable name
- Value string
- Value or column name
- Value
Reference string - Variable name
- value String
- Value or column name
- value
Reference String - Variable name
- value string
- Value or column name
- value
Reference string - Variable name
- value str
- Value or column name
- value_
reference str - Variable name
- value String
- Value or column name
- value
Reference String - Variable name
RulesetThreshold, RulesetThresholdArgs
RulesetThresholdType, RulesetThresholdTypeArgs
- Greater
Than Or Equal - GREATER_THAN_OR_EQUAL
- Less
Than Or Equal - LESS_THAN_OR_EQUAL
- Greater
Than - GREATER_THAN
- Less
Than - LESS_THAN
- Ruleset
Threshold Type Greater Than Or Equal - GREATER_THAN_OR_EQUAL
- Ruleset
Threshold Type Less Than Or Equal - LESS_THAN_OR_EQUAL
- Ruleset
Threshold Type Greater Than - GREATER_THAN
- Ruleset
Threshold Type Less Than - LESS_THAN
- Greater
Than Or Equal - GREATER_THAN_OR_EQUAL
- Less
Than Or Equal - LESS_THAN_OR_EQUAL
- Greater
Than - GREATER_THAN
- Less
Than - LESS_THAN
- Greater
Than Or Equal - GREATER_THAN_OR_EQUAL
- Less
Than Or Equal - LESS_THAN_OR_EQUAL
- Greater
Than - GREATER_THAN
- Less
Than - LESS_THAN
- GREATER_THAN_OR_EQUAL
- GREATER_THAN_OR_EQUAL
- LESS_THAN_OR_EQUAL
- LESS_THAN_OR_EQUAL
- GREATER_THAN
- GREATER_THAN
- LESS_THAN
- LESS_THAN
- "GREATER_THAN_OR_EQUAL"
- GREATER_THAN_OR_EQUAL
- "LESS_THAN_OR_EQUAL"
- LESS_THAN_OR_EQUAL
- "GREATER_THAN"
- GREATER_THAN
- "LESS_THAN"
- LESS_THAN
RulesetThresholdUnit, RulesetThresholdUnitArgs
- Count
- COUNT
- Percentage
- PERCENTAGE
- Ruleset
Threshold Unit Count - COUNT
- Ruleset
Threshold Unit Percentage - PERCENTAGE
- Count
- COUNT
- Percentage
- PERCENTAGE
- Count
- COUNT
- Percentage
- PERCENTAGE
- COUNT
- COUNT
- PERCENTAGE
- PERCENTAGE
- "COUNT"
- COUNT
- "PERCENTAGE"
- PERCENTAGE
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.