Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. databrew
  5. getRuleset

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.databrew.getRuleset

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::DataBrew::Ruleset.

Using getRuleset

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRuleset(args: GetRulesetArgs, opts?: InvokeOptions): Promise<GetRulesetResult>
function getRulesetOutput(args: GetRulesetOutputArgs, opts?: InvokeOptions): Output<GetRulesetResult>
Copy
def get_ruleset(name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRulesetResult
def get_ruleset_output(name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRulesetResult]
Copy
func LookupRuleset(ctx *Context, args *LookupRulesetArgs, opts ...InvokeOption) (*LookupRulesetResult, error)
func LookupRulesetOutput(ctx *Context, args *LookupRulesetOutputArgs, opts ...InvokeOption) LookupRulesetResultOutput
Copy

> Note: This function is named LookupRuleset in the Go SDK.

public static class GetRuleset 
{
    public static Task<GetRulesetResult> InvokeAsync(GetRulesetArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesetResult> Invoke(GetRulesetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRulesetResult> getRuleset(GetRulesetArgs args, InvokeOptions options)
public static Output<GetRulesetResult> getRuleset(GetRulesetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:databrew:getRuleset
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name of the Ruleset
Name This property is required. string
Name of the Ruleset
name This property is required. String
Name of the Ruleset
name This property is required. string
Name of the Ruleset
name This property is required. str
Name of the Ruleset
name This property is required. String
Name of the Ruleset

getRuleset Result

The following output properties are available:

Description string
Description of the Ruleset
Rules List<Pulumi.AwsNative.DataBrew.Outputs.RulesetRule>
List of the data quality rules in the ruleset
Description string
Description of the Ruleset
Rules []RulesetRule
List of the data quality rules in the ruleset
description String
Description of the Ruleset
rules List<RulesetRule>
List of the data quality rules in the ruleset
description string
Description of the Ruleset
rules RulesetRule[]
List of the data quality rules in the ruleset
description str
Description of the Ruleset
rules Sequence[RulesetRule]
List of the data quality rules in the ruleset
description String
Description of the Ruleset
rules List<Property Map>
List of the data quality rules in the ruleset

Supporting Types

RulesetColumnSelector

Name string
The name of a column from a dataset
Regex string
A regular expression for selecting a column from a dataset
Name string
The name of a column from a dataset
Regex string
A regular expression for selecting a column from a dataset
name String
The name of a column from a dataset
regex String
A regular expression for selecting a column from a dataset
name string
The name of a column from a dataset
regex string
A regular expression for selecting a column from a dataset
name str
The name of a column from a dataset
regex str
A regular expression for selecting a column from a dataset
name String
The name of a column from a dataset
regex String
A regular expression for selecting a column from a dataset

RulesetRule

CheckExpression This property is required. string
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .
Name This property is required. string
Name of the rule
ColumnSelectors List<Pulumi.AwsNative.DataBrew.Inputs.RulesetColumnSelector>
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
Disabled bool
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
SubstitutionMap List<Pulumi.AwsNative.DataBrew.Inputs.RulesetSubstitutionValue>
The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".
Threshold Pulumi.AwsNative.DataBrew.Inputs.RulesetThreshold
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
CheckExpression This property is required. string
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .
Name This property is required. string
Name of the rule
ColumnSelectors []RulesetColumnSelector
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
Disabled bool
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
SubstitutionMap []RulesetSubstitutionValue
The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".
Threshold RulesetThreshold
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
checkExpression This property is required. String
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .
name This property is required. String
Name of the rule
columnSelectors List<RulesetColumnSelector>
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
disabled Boolean
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
substitutionMap List<RulesetSubstitutionValue>
The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".
threshold RulesetThreshold
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
checkExpression This property is required. string
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .
name This property is required. string
Name of the rule
columnSelectors RulesetColumnSelector[]
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
disabled boolean
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
substitutionMap RulesetSubstitutionValue[]
The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".
threshold RulesetThreshold
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
check_expression This property is required. str
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .
name This property is required. str
Name of the rule
column_selectors Sequence[RulesetColumnSelector]
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
disabled bool
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
substitution_map Sequence[RulesetSubstitutionValue]
The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".
threshold RulesetThreshold
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
checkExpression This property is required. String
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .
name This property is required. String
Name of the rule
columnSelectors List<Property Map>
List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
disabled Boolean
A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
substitutionMap List<Property Map>
The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".
threshold Property Map
The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

RulesetSubstitutionValue

Value This property is required. string
Value or column name
ValueReference This property is required. string
Variable name
Value This property is required. string
Value or column name
ValueReference This property is required. string
Variable name
value This property is required. String
Value or column name
valueReference This property is required. String
Variable name
value This property is required. string
Value or column name
valueReference This property is required. string
Variable name
value This property is required. str
Value or column name
value_reference This property is required. str
Variable name
value This property is required. String
Value or column name
valueReference This property is required. String
Variable name

RulesetThreshold

Value This property is required. double
The value of a threshold.
Type Pulumi.AwsNative.DataBrew.RulesetThresholdType
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
Unit Pulumi.AwsNative.DataBrew.RulesetThresholdUnit
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
Value This property is required. float64
The value of a threshold.
Type RulesetThresholdType
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
Unit RulesetThresholdUnit
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
value This property is required. Double
The value of a threshold.
type RulesetThresholdType
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
unit RulesetThresholdUnit
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
value This property is required. number
The value of a threshold.
type RulesetThresholdType
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
unit RulesetThresholdUnit
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
value This property is required. float
The value of a threshold.
type RulesetThresholdType
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
unit RulesetThresholdUnit
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
value This property is required. Number
The value of a threshold.
type "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL" | "GREATER_THAN" | "LESS_THAN"
The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
unit "COUNT" | "PERCENTAGE"
Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.

RulesetThresholdType

RulesetThresholdUnit

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native