Class: Aws::GlueDataBrew::Types::CreateRulesetRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb

Overview

Note:

When making an API call, you may pass CreateRulesetRequest data as a hash:

{
  name: "RulesetName", # required
  description: "RulesetDescription",
  target_arn: "Arn", # required
  rules: [ # required
    {
      name: "RuleName", # required
      disabled: false,
      check_expression: "Expression", # required
      substitution_map: {
        "ValueReference" => "ConditionValue",
      },
      threshold: {
        value: 1.0, # required
        type: "GREATER_THAN_OR_EQUAL", # accepts GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN
        unit: "COUNT", # accepts COUNT, PERCENTAGE
      },
      column_selectors: [
        {
          regex: "ColumnName",
          name: "ColumnName",
        },
      ],
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the ruleset.

Returns:

  • (String)


948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 948

class CreateRulesetRequest < Struct.new(
  :name,
  :description,
  :target_arn,
  :rules,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Returns:

  • (String)


948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 948

class CreateRulesetRequest < Struct.new(
  :name,
  :description,
  :target_arn,
  :rules,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rulesArray<Types::Rule>

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

Returns:



948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 948

class CreateRulesetRequest < Struct.new(
  :name,
  :description,
  :target_arn,
  :rules,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Metadata tags to apply to the ruleset.

Returns:

  • (Hash<String,String>)


948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 948

class CreateRulesetRequest < Struct.new(
  :name,
  :description,
  :target_arn,
  :rules,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_arnString

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

Returns:

  • (String)


948
949
950
951
952
953
954
955
956
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 948

class CreateRulesetRequest < Struct.new(
  :name,
  :description,
  :target_arn,
  :rules,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end