Skip to contents

Modifies a Cedar static policy in the specified policy store

Source: R/verifiedpermissions_operations.R
verifiedpermissions_update_policy.Rd

Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using update_policy_template.

See https://www.paws-r-sdk.com/docs/verifiedpermissions_update_policy/ for full documentation.

Usage

verifiedpermissions_update_policy(
  policyStoreId,
  policyId,
  definition = NULL,
  name = NULL
)

Arguments

policyStoreId

[required] Specifies the ID of the policy store that contains the policy that you want to update.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

  • ID: PSEXAMPLEabcdefg111111

  • Alias name: policy-store-alias/example-policy-store

To view aliases, use list_policy_store_aliases.

policyId

[required] Specifies the ID of the policy that you want to update. To find this value, you can use list_policies.

You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

  • ID: SPEXAMPLEabcdefg111111

  • Name: name/example-policy

definition

Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

If you don't specify this parameter, the existing policy definition remains unchanged.

You can change only the following elements from the policy definition:

  • The action referenced by the policy.

  • Any conditional clauses, such as when or unless clauses.

You can't change the following elements:

  • Changing from static to templateLinked.

  • Changing the effect of the policy from permit or forbid.

  • The principal referenced by the policy.

  • The resource referenced by the policy.

name

Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.