Oracle Cloud Infrastructure Documentation

Editing a Queue

Update a queue.

    1. On the Queues list page, find the queue that you want to work with. If you need help finding the list page or the queue, see Listing Queues.
    2. From the Actions menu for the queue, select Edit queue.
    3. In the Edit queue panel, verify or change the following:
      • Name of the queue.
      • Visibility timeout value: How long a message in the queue is invisible to other consumers after being delivered to one.
      • Visibility timeout unit: Unit for the timeout value that can be specified in seconds, minutes, hours or days.
      • Maximum retention period: How long a message remains in the queue before it's deleted by the service, if it isn't deleted by a consumer.
        Note

        The queue's retention period can't be changed after creation.
      • Maximum channel consumption (Percentage): The maximum amount of the queue's storage and throughput that a channel can consume. Specified as a percentage. The default value is 100, which means that a single channel can use the entirety of the queue's bandwidth. For more information, see Channels.
    4. Verify or change the dead letter queue settings:
      • Dead letter queue (DLQ) settings: The maximum number of times a message is delivered before it's moved to the dead letter queue.
    5. Verify or change the encryption settings:
      • Oracle-managed key: Select this option to leave all encryption-related matters to Oracle.
      • Customer-managed key: Select this option to encrypt the queue using your own key that's stored in OCI Vault. This lets you rotate, disable, and delete it as needed. After selecting this option, select the vault that contains the key, and the key itself. For more information, see Updating the Master Encryption Key Assigned to a Queue.
    6. Click Update.

  • Use the oci queue queue-admin queue update command and required parameters to edit a queue:

    oci queue queue-admin queue update --queue-id <queue_OCID>

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Use the UpdateQueue operation to update a queue.

    For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.