Skip to main content

Policy

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Creates an access-control policy within the formation's project.

Syntax​

type: policy
properties:
  name: String
  description: String
  document: Document

Types: Document

Output​

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyPolicy

Properties​

name

Human-readable label for the policy

Required: No Type: String Nullable: Yes

description

Description of what the policy grants

Required: No Type: String Nullable: Yes

document

Policy document containing an array of statements

Required: Yes Type: Document

Sub-types​

Document​

Properties of the document object.

statement

IAM policy statements.

Required: No Type: Array of Statement

Statement​

Properties of each item in statement.

effect

Allow or Deny

Required: Yes Type: String

action

IAM action strings, e.g. memories:*.

Required: Yes Type: Array of String

resource

Resource SRN patterns. Omit to match every resource.

Required: No Type: Array of String Nullable: Yes

condition

Condition block: keys are condition operators mapping to context-key/value maps.

Required: No Type: Object Nullable: Yes