Oracle Cloud Infrastructure Documentation

Updating a Stream Pool

Change a stream pool's settings for Kafka use and encryption (master encryption key).

When you update a stream pool, you can also update its tags. For more information about tagging, see Resource Tags.

To review requirements for creating and managing streams, see Getting Started with Streaming.

    1. On the Stream Pools list page, select the stream pool that you want to work with. If you need help finding the list page or the stream pool, see Listing Stream Pools.
    2. On the details page, select Edit Settings.
    3. To use the stream pool with Kafka, select Auto create topics and configure the stream settings:
      • Default Retention Period (Hours): Specify a number of hours for the stream's retention period.
      • Default Number of Partitions: Specify the default number of partitions for the stream.
    4. To encrypt the data in the streams in this stream pool by using your own Vault encryption key, select Encrypt using customer-managed keys. To use the Vault service for your encryption needs, you need access to a vault and key, and you must allow the service to use the key.
      • Vault: Select the vault that contains the master encryption key that you want to use.
      • Master encryption key: Select the master encryption key that you want to use.

      For more information about encryption with a Vault key that you manage, see Overview of Vault and Managing Keys.

      Note

      You can also update encryption settings from the details page.

      • To stop using an Oracle-managed key in favor of a Vault master encryption key that you manage, select Assign, select a vault and encryption key you have access to, and then select Assign.
      • To select a different Vault master encryption key that you manage, select Update, select a vault and encryption key you have access to, and then select Update.
      • To remove the assigned Vault master encryption key and let Oracle manage the encryption key, select Unassign and then select Unassign again to confirm the removal of the existing key assignment.
    5. Select Edit Settings to save changes.
    6. (Optional) Add one or more tags to the stream pool: On the details page, select Tags.
      If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.

  • Use the oci streaming admin stream-pool update command and required parameters to update a stream pool:

    oci streaming admin stream-pool update --stream-pool-id <stream_pool_OCID>

    For example:

    oci streaming admin stream-pool update --stream-pool-id ocid1.streampool.oc1.phx.exampleuniqueID --name MyUpdatedStreamPool
{
  "data": {
    "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
    "custom-encryption-key": {
      "key-state": "NONE",
      "kms-key-id": null
    },
    "defined-tags": {},
    "endpoint-fqdn": "cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
    "freeform-tags": {},
    "id": "ocid1.streampool.oc1.phx.exampleuniqueID",
    "is-private": false,
    "kafka-settings": {
      "auto-create-topics-enable": false,
      "bootstrap-servers": "cell-1.streaming.us-phoenix-1.oci.oraclecloud.com:9092",
      "log-retention-hours": 24,
      "num-partitions": 1
    },
    "lifecycle-state": "UPDATING",
    "lifecycle-state-details": null,
    "name": "MyUpdatedStreamPool",
    "private-endpoint-settings": {
      "nsg-ids": null,
      "private-endpoint-ip": null,
      "subnet-id": null
    },
    "time-created": "2020-11-02T23:01:59.429000+00:00"
  },
  "etag": "\"6ad44a83-4804-4cb5-87ae-2100d3a7012c-9679fcb9-37b7-48c5-9114-d514f132d363\""
}
    Tip

    Provide input for --custom-encryption-key-details, --private-endpoint-details, and --kafka-settings as valid formatted JSON. See Passing Complex Input and Using a JSON File for Complex Input for information about JSON formatting.

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

  • Run the UpdateStreamPool operation to update a stream pool.

Using Resource Manager and Terraform

Update the oci_streaming_stream_pool resource in your Terraform configuration and edit your stack or run a terraform apply job.

About Resource Manager and Terraform

Resource Manager is an Oracle Cloud Infrastructure (OCI) service that allows you to automate the process of provisioning your OCI resources. Using Terraform, Resource Manager helps you install, configure, and manage resources through the "infrastructure-as-code" model.

A Terraform configuration codifies your infrastructure in declarative configuration files. The configuration defines the resources you intend to provision, variables, and specific instructions for provisioning the resources

You can use Resource Manager or the Terraform CLI with the OCI Terraform provider to see how your streams and stream pools are represented in Terraform configuration files.

For more information about writing configurations for use with Resource Manager, see Terraform Configurations for Resource Manager and Terraform Configuration.