In previous documentation, rule is referred to as classifier or identifier and framework is referred to as template.
Sensitive data discovery must be enabled.
immuta sdd template
This command allows you to manage identification frameworks, which are a collection of rules and settings used to drive the configuration of SDD runs. The table below illustrates subcommands and arguments.
Use these options to get more details about the sdd template
command or any of its subcommands:
-h
--help
Save your framework to a valid YAML or JSON file using these attributes:
An example is provided below.
Run immuta sdd template create <filepath> [flags]
, referencing the file you just created. The options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
Run immuta sdd template get <frameworkName> [flags]
, specifying the name of the framework you would like to get. Options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
The example below illustrates a user getting a framework named ACCOUNT_NUMBERS_FRAMEWORK.
Run immuta sdd template global [flags]
, to get the global framework that has been configured for sensitive data discovery. Options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
The example below illustrates a user getting the global framework that had been configured in the Immuta UI by an administrator.
Run immuta sdd template search [string] [flags]
to list all identification frameworks or search identification frameworks by name. Options you can specify include
--classifiers strings
: Limit results to only frameworks that contain the specified rules.
-h
, --help
: Help for search.
--limit int
The search limit for pagination (default 25).
--offset int
: The search offset for pagination.
--order asc | desc
: The sort order.
-o
, --output json | yaml
: The output format.
--outputTemplate string
: Format the response using a Go template.
-s
, --sort id | name | displayName | type | createdAt | updatedAt
: Field to sort by.
The example below illustrates a user searching all frameworks containing the ACCOUNT_NUMBER_RULE
.
Update your framework in a valid YAML or JSON file using these attributes:
Run immuta sdd template update <frameworkName> <filepath> [flags]
, referencing the file you just updated. The options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
The example below illustrates a user updating a framework named ACCOUNT_NUMBERS_FRAMEWORK.
Run immuta sdd template delete <frameworkName> [flags]
to delete the framework. The options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
Subcommands | Aliases | Description |
---|---|---|
Attribute | Description | Required |
---|---|---|
Attribute | Description | Required |
---|---|---|
save
Create an identification framework.
None
Delete the passed identification framework.
None
Get an identification framework.
None
Get the global framework.
ls
, list
Search all identification frameworks.
None
Update an identification framework.
name
string
Unique, request-friendly framework name.
Yes
displayName
string
Unique, human-readable framework name.
Yes
description
string
The framework description.
Yes
classifiers
array
Includes each rules's name
and overrides
for minConfidence
and tags
.
Yes
name
string
Unique, request-friendly framework name.
Yes
displayName
string
Unique, human-readable framework name.
Yes
description
string
The framework description.
Yes
classifiers
array
Includes each rules's name
and overrides
for minConfidence
and tags
.
Yes