[ aws . verifiedpermissions ]

update-policy

Description

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 UpdatePolicyTemplate .

Note

If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn’t pass validation, the operation fails and the update isn’t stored.

See also: AWS API Documentation

Synopsis

  update-policy
--policy-store-id <value>
--policy-id <value>
--definition <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--policy-store-id (string)

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

--policy-id (string)

Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies .

--definition (tagged union structure)

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

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.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: static.

static -> (structure)

Contains details about the updates to be applied to a static policy.

description -> (string)

Specifies the description to be added to or replaced on the static policy.

statement -> (string)

Specifies the Cedar policy language text to be added to or replaced on the static policy.

Warning

You can change only the following elements from the original content:

• The action referenced by the policy.
• Any conditional clauses, such as when or unless clauses.

You can’t change the following elements:

• Changing from StaticPolicy to TemplateLinkedPolicy .
• The effect (permit or forbid ) of the policy.
• The principal referenced by the policy.
• The resource referenced by the policy.

Shorthand Syntax:

static={description=string,statement=string}

JSON Syntax:

{
  "static": {
    "description": "string",
    "statement": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

policyStoreId -> (string)

The ID of the policy store that contains the policy that was updated.

policyId -> (string)

The ID of the policy that was updated.

policyType -> (string)

The type of the policy that was updated.

principal -> (structure)

The principal specified in the policy’s scope. This element isn’t included in the response when Principal isn’t present in the policy content.

entityType -> (string)

The type of an entity.

Example: "entityType":"*typeName* "

entityId -> (string)

The identifier of an entity.

"entityId":"*identifier* "

resource -> (structure)

The resource specified in the policy’s scope. This element isn’t included in the response when Resource isn’t present in the policy content.

entityType -> (string)

The type of an entity.

Example: "entityType":"*typeName* "

entityId -> (string)

The identifier of an entity.

"entityId":"*identifier* "

createdDate -> (timestamp)

The date and time that the policy was originally created.

lastUpdatedDate -> (timestamp)

The date and time that the policy was most recently updated.