We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
aws-native.databrew.getRuleset
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
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>
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]
func LookupRuleset(ctx *Context, args *LookupRulesetArgs, opts ...InvokeOption) (*LookupRulesetResult, error)
func LookupRulesetOutput(ctx *Context, args *LookupRulesetOutputArgs, opts ...InvokeOption) LookupRulesetResultOutput
> 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)
}
public static CompletableFuture<GetRulesetResult> getRuleset(GetRulesetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:databrew:getRuleset
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of the Ruleset
- Name string
- Name of the Ruleset
- name String
- Name of the Ruleset
- name string
- Name of the Ruleset
- name str
- Name of the Ruleset
- name String
- Name of the Ruleset
getRuleset Result
The following output properties are available:
- Description string
- Description of the Ruleset
- Rules
List<Pulumi.
Aws Native. Data Brew. Outputs. Ruleset Rule> - List of the data quality rules in the ruleset
- Description string
- Description of the Ruleset
- Rules
[]Ruleset
Rule - List of the data quality rules in the ruleset
- description String
- Description of the Ruleset
- rules
List<Ruleset
Rule> - List of the data quality rules in the ruleset
- description string
- Description of the Ruleset
- rules
Ruleset
Rule[] - List of the data quality rules in the ruleset
- description str
- Description of the Ruleset
- rules
Sequence[Ruleset
Rule] - 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
RulesetRule
- Check
Expression 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 string
- Name of the rule
- Column
Selectors List<Pulumi.Aws Native. Data Brew. Inputs. Ruleset Column Selector> - 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 List<Pulumi.Aws Native. Data Brew. Inputs. Ruleset Substitution Value> - 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.
Aws Native. Data Brew. Inputs. Ruleset Threshold - 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 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 string
- Name of the rule
- Column
Selectors []RulesetColumn Selector - 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 []RulesetSubstitution Value - 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
Ruleset
Threshold - 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 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 String
- Name of the rule
- column
Selectors List<RulesetColumn Selector> - 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.
- substitution
Map List<RulesetSubstitution Value> - 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
Ruleset
Threshold - 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 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 string
- Name of the rule
- column
Selectors RulesetColumn Selector[] - 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.
- substitution
Map RulesetSubstitution Value[] - 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
Ruleset
Threshold - 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 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 str
- Name of the rule
- column_
selectors Sequence[RulesetColumn Selector] - 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[RulesetSubstitution Value] - 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
Ruleset
Threshold - 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 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 String
- Name of the rule
- column
Selectors 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.
- substitution
Map 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 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
- Value double
- The value of a threshold.
- Type
Pulumi.
Aws Native. Data Brew. Ruleset Threshold Type - The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
- Unit
Pulumi.
Aws Native. Data Brew. Ruleset Threshold Unit - Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
- Value float64
- The value of a threshold.
- Type
Ruleset
Threshold Type - The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
- Unit
Ruleset
Threshold Unit - Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
- value Double
- The value of a threshold.
- type
Ruleset
Threshold Type - The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
- unit
Ruleset
Threshold Unit - Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
- value number
- The value of a threshold.
- type
Ruleset
Threshold Type - The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
- unit
Ruleset
Threshold Unit - Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
- value float
- The value of a threshold.
- type
Ruleset
Threshold Type - The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
- unit
Ruleset
Threshold Unit - Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
- value 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.0.1 published on Tuesday, Oct 1, 2024 by Pulumi