1. Packages
  2. AWS Native
  3. API Docs
  4. databrew
  5. Ruleset

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.databrew.Ruleset

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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.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.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 TagArgs
    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<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 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[TagArgs]
    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>

    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

    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

    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

    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

    Tag, TagArgs

    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

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi