rulesets

Used to retrieve a list of rulesets in a region or to create or delete a rulesets resource, use ruleset to read or update an individual resource.

Overview

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

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, TargetArn, Rules, region
delete_resource	DELETE	data__Identifier, region
list_resource	SELECT	region

SELECT Example

SELECT
region,
name
FROM aws.databrew.rulesets
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 aws.databrew.rulesets (
 Name,
 TargetArn,
 Rules,
 region
)
SELECT 
'{{ Name }}',
 '{{ TargetArn }}',
 '{{ Rules }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.databrew.rulesets (
 Name,
 Description,
 TargetArn,
 Rules,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ TargetArn }}',
 '{{ 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: TargetArn
        value: '{{ TargetArn }}'
      - name: Rules
        value:
          - Name: '{{ Name }}'
            Disabled: '{{ Disabled }}'
            CheckExpression: '{{ CheckExpression }}'
            SubstitutionMap:
              - ValueReference: '{{ ValueReference }}'
                Value: '{{ Value }}'
            Threshold:
              Value: null
              Type: '{{ Type }}'
              Unit: '{{ Unit }}'
            ColumnSelectors:
              - Regex: '{{ Regex }}'
                Name: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE Example

/*+ delete */
DELETE FROM aws.databrew.rulesets
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

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

Delete

databrew:DeleteRuleset

List

databrew:ListRulesets,
databrew:ListTagsForResource,
iam:ListRoles