Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. databrew
  5. Ruleset

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.databrew.Ruleset

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.CreateOnlyTagArgs]] = 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.

    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.AwsNative.DataBrew.Inputs.RulesetRule>
    List of the data quality rules in the ruleset
    TargetArn string
    Arn of the target resource (dataset) to apply the ruleset to
    Description string
    Description of the Ruleset
    Name string
    Name of the Ruleset
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    Rules []RulesetRuleArgs
    List of the data quality rules in the ruleset
    TargetArn string
    Arn of the target resource (dataset) to apply the ruleset to
    Description string
    Description of the Ruleset
    Name string
    Name of the Ruleset
    Tags CreateOnlyTagArgs

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    rules List<RulesetRule>
    List of the data quality rules in the ruleset
    targetArn String
    Arn of the target resource (dataset) to apply the ruleset to
    description String
    Description of the Ruleset
    name String
    Name of the Ruleset
    tags List<CreateOnlyTag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    rules RulesetRule[]
    List of the data quality rules in the ruleset
    targetArn string
    Arn of the target resource (dataset) to apply the ruleset to
    description string
    Description of the Ruleset
    name string
    Name of the Ruleset
    tags CreateOnlyTag[]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    rules Sequence[RulesetRuleArgs]
    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
    tags Sequence[CreateOnlyTagArgs]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    rules List<Property Map>
    List of the data quality rules in the ruleset
    targetArn String
    Arn of the target resource (dataset) to apply the ruleset to
    description String
    Description of the Ruleset
    name String
    Name of the Ruleset
    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    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

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    RulesetColumnSelector, RulesetColumnSelectorArgs

    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, RulesetRuleArgs

    CheckExpression 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
    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 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
    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 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
    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 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
    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 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[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 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
    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, RulesetSubstitutionValueArgs

    Value string
    Value or column name
    ValueReference string
    Variable name
    Value string
    Value or column name
    ValueReference string
    Variable name
    value String
    Value or column name
    valueReference String
    Variable name
    value string
    Value or column name
    valueReference string
    Variable name
    value str
    Value or column name
    value_reference str
    Variable name
    value String
    Value or column name
    valueReference String
    Variable name

    RulesetThreshold, RulesetThresholdArgs

    Value 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 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 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 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 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 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, RulesetThresholdTypeArgs

    GreaterThanOrEqual
    GREATER_THAN_OR_EQUAL
    LessThanOrEqual
    LESS_THAN_OR_EQUAL
    GreaterThan
    GREATER_THAN
    LessThan
    LESS_THAN
    RulesetThresholdTypeGreaterThanOrEqual
    GREATER_THAN_OR_EQUAL
    RulesetThresholdTypeLessThanOrEqual
    LESS_THAN_OR_EQUAL
    RulesetThresholdTypeGreaterThan
    GREATER_THAN
    RulesetThresholdTypeLessThan
    LESS_THAN
    GreaterThanOrEqual
    GREATER_THAN_OR_EQUAL
    LessThanOrEqual
    LESS_THAN_OR_EQUAL
    GreaterThan
    GREATER_THAN
    LessThan
    LESS_THAN
    GreaterThanOrEqual
    GREATER_THAN_OR_EQUAL
    LessThanOrEqual
    LESS_THAN_OR_EQUAL
    GreaterThan
    GREATER_THAN
    LessThan
    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
    RulesetThresholdUnitCount
    COUNT
    RulesetThresholdUnitPercentage
    PERCENTAGE
    Count
    COUNT
    Percentage
    PERCENTAGE
    Count
    COUNT
    Percentage
    PERCENTAGE
    COUNT
    COUNT
    PERCENTAGE
    PERCENTAGE
    "COUNT"
    COUNT
    "PERCENTAGE"
    PERCENTAGE

    Package Details

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

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

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native