Oracle Cloud Infrastructure Documentation

Getting Details for a Stream Pool

Get the details for a stream pool in the Streaming service. Stream pool details include encryption and Kafka Connect settings.

    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. (Optional) To view Kafka Connect configuration values, select Kafka Connection Settings.

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

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

    For example:

    oci streaming admin stream-pool get --stream-pool-id ocid1.streampool.oc1.phx.exampleuniqueID
{
  "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": "ACTIVE",
    "lifecycle-state-details": null,
    "name": "MyStreamPool",
    "private-endpoint-settings": {
      "nsg-ids": null,
      "private-endpoint-ip": null,
      "subnet-id": null
    },
    "time-created": "2020-11-02T23:01:59.429000+00:00"
  },
  "etag": "\"6934531c-efaa-40ba-b083-94eb2350d737-a8b10bda-09cc-45e1-800b-b66b4bc29353\""
}

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

  • Run the GetStreamPool operation to get details for a stream pool.

Using Resource Manager and Terraform

Use the oci_streaming_stream_pool data source to get the details for a stream pool.

For example:

data "oci_streaming_stream_pool" "test_stream_pool" {
    #Required
    stream_pool_id = oci_streaming_stream_pool.test_stream_pool.id
}
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.