rulesets

Creates, updates, deletes or gets a ruleset resource or lists rulesets in a region

Overview

Name	rulesets
Type	Resource
Description	Resource schema for AWS::DataBrew::Ruleset.
Id	awscc.databrew.rulesets

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of the Ruleset
description	string	Description of the Ruleset
target_arn	string	Arn of the target resource (dataset) to apply the ruleset to
▶rules	array	List of the data quality rules in the ruleset
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	Name of the Ruleset
region	string	AWS region.

For more information, see AWS::DataBrew::Ruleset.

Methods

Name	Resource	Accessible by	Required Params
create_resource	rulesets	INSERT	Name, TargetArn, Rules, region
delete_resource	rulesets	DELETE	Identifier, region
update_resource	rulesets	UPDATE	Identifier, PatchDocument, region
list_resources	rulesets_list_only	SELECT	region
get_resource	rulesets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual ruleset.

SELECT
  region,
  name,
  description,
  target_arn,
  rules,
  tags
FROM awscc.databrew.rulesets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all rulesets in a region.

SELECT
  region,
  name
FROM awscc.databrew.rulesets_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new ruleset resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.databrew.rulesets (
  Name,
  TargetArn,
  Rules,
  region
)
SELECT
  '{{ name }}',
  '{{ target_arn }}',
  '{{ rules }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.databrew.rulesets (
  Name,
  Description,
  TargetArn,
  Rules,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ target_arn }}',
  '{{ rules }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: ruleset
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: target_arn
        value: '{{ target_arn }}'
      - name: rules
        value:
          - name: '{{ name }}'
            disabled: '{{ disabled }}'
            check_expression: '{{ check_expression }}'
            substitution_map:
              - value_reference: '{{ value_reference }}'
                value: '{{ value }}'
            threshold:
              value: null
              type: '{{ type }}'
              unit: '{{ unit }}'
            column_selectors:
              - regex: '{{ regex }}'
                name: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a ruleset resource, using stack-deploy.

/*+ update */
UPDATE awscc.databrew.rulesets
SET PatchDocument = string('{{ {
    "Description": description,
    "Rules": rules,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.databrew.rulesets
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

To operate on the rulesets resource, the following permissions are required:

Create

databrew:CreateRuleset,
databrew:DescribeRuleset,
databrew:TagResource,
databrew:UntagResource,
iam:PassRole

Read

databrew:DescribeRuleset,
iam:ListRoles

Update

databrew:UpdateRuleset,
databrew:TagResource,
databrew:UntagResource

Delete

databrew:DeleteRuleset

List

databrew:ListRulesets,
databrew:ListTagsForResource,
iam:ListRoles