Files
threshold/website/content/docs/commands/policies/index.mdx
T
5dbf57ebfa chore: add storage policy documentation (#4246)
* chore: update create storage bucket readme

* chore: update domain model docs for storage policy

* fix(website): update docs nav data

* docs: Update navigation

* docs: Copy edits

* chore: add resultant set of policy examples

* doc: Update resultant set of policy examples

* docs: Add policies to CLI commands

* docs: Add note about default policy name

* adds configure storage policies usage docs

* updates s3 policies to include the bucket resource itself

* adds commands/policies routes back

* Apply suggestions from code review

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

* adds Manual deletion section

* updates UI step

* adds update storage policies usage doc

* attribute description updates and formatting fixes

* Apply suggestions from code review

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-01-30 20:20:43 -05:00

51 lines
1.5 KiB
Plaintext

---
layout: docs
page_title: policies - Command
description: |-
The "policies" command lets you perform operations on Boundary policy resources.
---
# policies
<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary or Boundary Enterprise</a></EnterpriseAlert>
Command: `boundary policies`
The `policies` command lets you perform operations on Boundary policies.
Storage policies codify how long session recordings must be kept and when they should be deleted.
For more information, refer to the [storage policies](/boundary/docs/concepts/domain-model/storage-policy) documentation.
## Example
The following command reads a policy with the id `pst_1234567890`:
```shell-session
$ boundary policies read -id chr_1234567890
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
Usage: boundary policies <subcommand> [options] [args]
# ...
Subcommands:
create Create a policy
delete Delete a policy
list List a policy
read Read a policy
update Update a policy
```
</CodeBlockConfig>
For more information, examples, and usage, click on the name
of the subcommand in the sidebar or one of the links below:
- [create](/boundary/docs/commands/policies/create)
- [delete](/boundary/docs/commands/policies/delete)
- [list](/boundary/docs/commands/policies/list)
- [read](/boundary/docs/commands/policies/read)
- [update](/boundary/docs/commands/policies/update)