Skip to content

Create Policy

verifiedpermissions_create_policy R Documentation

Creates a Cedar policy and saves it in the specified policy store

Description

Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.

  • To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition.

  • To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.

Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.

Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.

Usage

verifiedpermissions_create_policy(clientToken, policyStoreId,
  definition)

Arguments

clientToken

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

policyStoreId

[required] Specifies the PolicyStoreId of the policy store you want to store the policy in.

definition

[required] A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.

Value

A list with the following syntax: 

list(
  policyStoreId = "string",
  policyId = "string",
  policyType = "STATIC"|"TEMPLATE_LINKED",
  principal = list(
    entityType = "string",
    entityId = "string"
  ),
  resource = list(
    entityType = "string",
    entityId = "string"
  ),
  actions = list(
    list(
      actionType = "string",
      actionId = "string"
    )
  ),
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedDate = as.POSIXct(
    "2015-01-01"
  ),
  effect = "Permit"|"Forbid"
)

Request syntax

svc$create_policy(
  clientToken = "string",
  policyStoreId = "string",
  definition = list(
    static = list(
      description = "string",
      statement = "string"
    ),
    templateLinked = list(
      policyTemplateId = "string",
      principal = list(
        entityType = "string",
        entityId = "string"
      ),
      resource = list(
        entityType = "string",
        entityId = "string"
      )
    )
  )
)