Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

playbook

class lakeformation.pb.playbook.Playbook(boto_ses: Optional[boto3.session.Session] = None, workspace_dir: Optional[Union[pathlib.Path, str]] = None, _skip_validation: bool = False)

[CN]

Playbook 是一个用于管理 LakeFormation Object 的抽象类. 也可以理解为一个数据容器.

每一个 Playbook 只能负责一个 AWS Account 的一个 Region.

Parameters

_skip_validation – internal parameter for testing. If true, skip validation for boto session and workspace directory.

validate()

Validate playbook arguments.

property deployed_pb_json: pathlib.Path

Return the path of the deployed playbook json file.

classmethod deserialize(data: dict) → lakeformation.pb.playbook.Playbook

Note

When you serialize, all LF tag instance are managed by playbook, When you deserialize, you should manually associate Lf tag instance with playbook

Parameters

data –

Returns

load_deployed_playbook()

Load deployed LakeFormation object from the Playbook.deployed_pb_json file.

If it is not exists, then initiate an empty Playbook and serialize it to Playbook.deployed_pb_json` file

property tag_mapper: Dict[str, ordered_set.OrderedSet]

Aggregate tag by key, and put values for the same key into a set.

apply(verbose=True, dry_run=False)

Parameters

• verbose –

• dry_run –

Returns

**

apply_tags(verbose=True, dry_run=False)

Ref:

• Create: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lakeformation.html#LakeFormation.Client.create_lf_tag

• Update: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lakeformation.html#LakeFormation.Client.update_lf_tag

• Delete: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lakeformation.html#LakeFormation.Client.delete_lf_tag

apply_tag_attachment(verbose=True, dry_run=False)

Ref:

• Add: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lakeformation.html#LakeFormation.Client.add_lf_tags_to_resource

• Remove: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lakeformation.html#LakeFormation.Client.remove_lf_tags_from_resource

• Get: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lakeformation.html#LakeFormation.Client.get_resource_lf_tags

apply_dl_permission(verbose=True, dry_run=False)

Parameters

• verbose –

• dry_run –

Returns