Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Streaming
  5. StreamPool
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.Streaming.StreamPool

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Stream Pool resource in Oracle Cloud Infrastructure Streaming service.

    Starts the provisioning of a new stream pool. To track the progress of the provisioning, you can periodically call GetStreamPool. In the response, the lifecycleState parameter of the object tells you its current state.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testStreamPool = new oci.streaming.StreamPool("test_stream_pool", {
    compartmentId: compartmentId,
    name: streamPoolName,
    customEncryptionKey: {
        kmsKeyId: testKey.id,
    },
    definedTags: streamPoolDefinedTags,
    freeformTags: {
        Department: "Finance",
    },
    kafkaSettings: {
        autoCreateTopicsEnable: streamPoolKafkaSettingsAutoCreateTopicsEnable,
        bootstrapServers: streamPoolKafkaSettingsBootstrapServers,
        logRetentionHours: streamPoolKafkaSettingsLogRetentionHours,
        numPartitions: streamPoolKafkaSettingsNumPartitions,
    },
    privateEndpointSettings: {
        nsgIds: streamPoolPrivateEndpointSettingsNsgIds,
        privateEndpointIp: streamPoolPrivateEndpointSettingsPrivateEndpointIp,
        subnetId: testSubnet.id,
    },
});

    import pulumi
import pulumi_oci as oci

test_stream_pool = oci.streaming.StreamPool("test_stream_pool",
    compartment_id=compartment_id,
    name=stream_pool_name,
    custom_encryption_key={
        "kms_key_id": test_key["id"],
    },
    defined_tags=stream_pool_defined_tags,
    freeform_tags={
        "Department": "Finance",
    },
    kafka_settings={
        "auto_create_topics_enable": stream_pool_kafka_settings_auto_create_topics_enable,
        "bootstrap_servers": stream_pool_kafka_settings_bootstrap_servers,
        "log_retention_hours": stream_pool_kafka_settings_log_retention_hours,
        "num_partitions": stream_pool_kafka_settings_num_partitions,
    },
    private_endpoint_settings={
        "nsg_ids": stream_pool_private_endpoint_settings_nsg_ids,
        "private_endpoint_ip": stream_pool_private_endpoint_settings_private_endpoint_ip,
        "subnet_id": test_subnet["id"],
    })

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/streaming"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := streaming.NewStreamPool(ctx, "test_stream_pool", &streaming.StreamPoolArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Name:          pulumi.Any(streamPoolName),
			CustomEncryptionKey: &streaming.StreamPoolCustomEncryptionKeyArgs{
				KmsKeyId: pulumi.Any(testKey.Id),
			},
			DefinedTags: pulumi.Any(streamPoolDefinedTags),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			KafkaSettings: &streaming.StreamPoolKafkaSettingsArgs{
				AutoCreateTopicsEnable: pulumi.Any(streamPoolKafkaSettingsAutoCreateTopicsEnable),
				BootstrapServers:       pulumi.Any(streamPoolKafkaSettingsBootstrapServers),
				LogRetentionHours:      pulumi.Any(streamPoolKafkaSettingsLogRetentionHours),
				NumPartitions:          pulumi.Any(streamPoolKafkaSettingsNumPartitions),
			},
			PrivateEndpointSettings: &streaming.StreamPoolPrivateEndpointSettingsArgs{
				NsgIds:            pulumi.Any(streamPoolPrivateEndpointSettingsNsgIds),
				PrivateEndpointIp: pulumi.Any(streamPoolPrivateEndpointSettingsPrivateEndpointIp),
				SubnetId:          pulumi.Any(testSubnet.Id),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testStreamPool = new Oci.Streaming.StreamPool("test_stream_pool", new()
    {
        CompartmentId = compartmentId,
        Name = streamPoolName,
        CustomEncryptionKey = new Oci.Streaming.Inputs.StreamPoolCustomEncryptionKeyArgs
        {
            KmsKeyId = testKey.Id,
        },
        DefinedTags = streamPoolDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        KafkaSettings = new Oci.Streaming.Inputs.StreamPoolKafkaSettingsArgs
        {
            AutoCreateTopicsEnable = streamPoolKafkaSettingsAutoCreateTopicsEnable,
            BootstrapServers = streamPoolKafkaSettingsBootstrapServers,
            LogRetentionHours = streamPoolKafkaSettingsLogRetentionHours,
            NumPartitions = streamPoolKafkaSettingsNumPartitions,
        },
        PrivateEndpointSettings = new Oci.Streaming.Inputs.StreamPoolPrivateEndpointSettingsArgs
        {
            NsgIds = streamPoolPrivateEndpointSettingsNsgIds,
            PrivateEndpointIp = streamPoolPrivateEndpointSettingsPrivateEndpointIp,
            SubnetId = testSubnet.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Streaming.StreamPool;
import com.pulumi.oci.Streaming.StreamPoolArgs;
import com.pulumi.oci.Streaming.inputs.StreamPoolCustomEncryptionKeyArgs;
import com.pulumi.oci.Streaming.inputs.StreamPoolKafkaSettingsArgs;
import com.pulumi.oci.Streaming.inputs.StreamPoolPrivateEndpointSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testStreamPool = new StreamPool("testStreamPool", StreamPoolArgs.builder()
            .compartmentId(compartmentId)
            .name(streamPoolName)
            .customEncryptionKey(StreamPoolCustomEncryptionKeyArgs.builder()
                .kmsKeyId(testKey.id())
                .build())
            .definedTags(streamPoolDefinedTags)
            .freeformTags(Map.of("Department", "Finance"))
            .kafkaSettings(StreamPoolKafkaSettingsArgs.builder()
                .autoCreateTopicsEnable(streamPoolKafkaSettingsAutoCreateTopicsEnable)
                .bootstrapServers(streamPoolKafkaSettingsBootstrapServers)
                .logRetentionHours(streamPoolKafkaSettingsLogRetentionHours)
                .numPartitions(streamPoolKafkaSettingsNumPartitions)
                .build())
            .privateEndpointSettings(StreamPoolPrivateEndpointSettingsArgs.builder()
                .nsgIds(streamPoolPrivateEndpointSettingsNsgIds)
                .privateEndpointIp(streamPoolPrivateEndpointSettingsPrivateEndpointIp)
                .subnetId(testSubnet.id())
                .build())
            .build());

    }
}

    resources:
  testStreamPool:
    type: oci:Streaming:StreamPool
    name: test_stream_pool
    properties:
      compartmentId: ${compartmentId}
      name: ${streamPoolName}
      customEncryptionKey:
        kmsKeyId: ${testKey.id}
      definedTags: ${streamPoolDefinedTags}
      freeformTags:
        Department: Finance
      kafkaSettings:
        autoCreateTopicsEnable: ${streamPoolKafkaSettingsAutoCreateTopicsEnable}
        bootstrapServers: ${streamPoolKafkaSettingsBootstrapServers}
        logRetentionHours: ${streamPoolKafkaSettingsLogRetentionHours}
        numPartitions: ${streamPoolKafkaSettingsNumPartitions}
      privateEndpointSettings:
        nsgIds: ${streamPoolPrivateEndpointSettingsNsgIds}
        privateEndpointIp: ${streamPoolPrivateEndpointSettingsPrivateEndpointIp}
        subnetId: ${testSubnet.id}

    Create StreamPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StreamPool(name: string, args: StreamPoolArgs, opts?: CustomResourceOptions);
    @overload
def StreamPool(resource_name: str,
               args: StreamPoolArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def StreamPool(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               compartment_id: Optional[str] = None,
               custom_encryption_key: Optional[_streaming.StreamPoolCustomEncryptionKeyArgs] = None,
               defined_tags: Optional[Mapping[str, str]] = None,
               freeform_tags: Optional[Mapping[str, str]] = None,
               kafka_settings: Optional[_streaming.StreamPoolKafkaSettingsArgs] = None,
               name: Optional[str] = None,
               private_endpoint_settings: Optional[_streaming.StreamPoolPrivateEndpointSettingsArgs] = None)
    func NewStreamPool(ctx *Context, name string, args StreamPoolArgs, opts ...ResourceOption) (*StreamPool, error)
    public StreamPool(string name, StreamPoolArgs args, CustomResourceOptions? opts = null)
    public StreamPool(String name, StreamPoolArgs args)
public StreamPool(String name, StreamPoolArgs args, CustomResourceOptions options)

    type: oci:Streaming:StreamPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StreamPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StreamPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StreamPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var streamPoolResource = new Oci.Streaming.StreamPool("streamPoolResource", new()
{
    CompartmentId = "string",
    CustomEncryptionKey = new Oci.Streaming.Inputs.StreamPoolCustomEncryptionKeyArgs
    {
        KmsKeyId = "string",
        KeyState = "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    KafkaSettings = new Oci.Streaming.Inputs.StreamPoolKafkaSettingsArgs
    {
        AutoCreateTopicsEnable = false,
        BootstrapServers = "string",
        LogRetentionHours = 0,
        NumPartitions = 0,
    },
    Name = "string",
    PrivateEndpointSettings = new Oci.Streaming.Inputs.StreamPoolPrivateEndpointSettingsArgs
    {
        NsgIds = new[]
        {
            "string",
        },
        PrivateEndpointIp = "string",
        SubnetId = "string",
    },
});

    example, err := Streaming.NewStreamPool(ctx, "streamPoolResource", &Streaming.StreamPoolArgs{
	CompartmentId: pulumi.String("string"),
	CustomEncryptionKey: &streaming.StreamPoolCustomEncryptionKeyArgs{
		KmsKeyId: pulumi.String("string"),
		KeyState: pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KafkaSettings: &streaming.StreamPoolKafkaSettingsArgs{
		AutoCreateTopicsEnable: pulumi.Bool(false),
		BootstrapServers:       pulumi.String("string"),
		LogRetentionHours:      pulumi.Int(0),
		NumPartitions:          pulumi.Int(0),
	},
	Name: pulumi.String("string"),
	PrivateEndpointSettings: &streaming.StreamPoolPrivateEndpointSettingsArgs{
		NsgIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrivateEndpointIp: pulumi.String("string"),
		SubnetId:          pulumi.String("string"),
	},
})

    var streamPoolResource = new StreamPool("streamPoolResource", StreamPoolArgs.builder()
    .compartmentId("string")
    .customEncryptionKey(StreamPoolCustomEncryptionKeyArgs.builder()
        .kmsKeyId("string")
        .keyState("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .kafkaSettings(StreamPoolKafkaSettingsArgs.builder()
        .autoCreateTopicsEnable(false)
        .bootstrapServers("string")
        .logRetentionHours(0)
        .numPartitions(0)
        .build())
    .name("string")
    .privateEndpointSettings(StreamPoolPrivateEndpointSettingsArgs.builder()
        .nsgIds("string")
        .privateEndpointIp("string")
        .subnetId("string")
        .build())
    .build());

    stream_pool_resource = oci.streaming.StreamPool("streamPoolResource",
    compartment_id="string",
    custom_encryption_key={
        "kms_key_id": "string",
        "key_state": "string",
    },
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    kafka_settings={
        "auto_create_topics_enable": False,
        "bootstrap_servers": "string",
        "log_retention_hours": 0,
        "num_partitions": 0,
    },
    name="string",
    private_endpoint_settings={
        "nsg_ids": ["string"],
        "private_endpoint_ip": "string",
        "subnet_id": "string",
    })

    const streamPoolResource = new oci.streaming.StreamPool("streamPoolResource", {
    compartmentId: "string",
    customEncryptionKey: {
        kmsKeyId: "string",
        keyState: "string",
    },
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    kafkaSettings: {
        autoCreateTopicsEnable: false,
        bootstrapServers: "string",
        logRetentionHours: 0,
        numPartitions: 0,
    },
    name: "string",
    privateEndpointSettings: {
        nsgIds: ["string"],
        privateEndpointIp: "string",
        subnetId: "string",
    },
});

    type: oci:Streaming:StreamPool
properties:
    compartmentId: string
    customEncryptionKey:
        keyState: string
        kmsKeyId: string
    definedTags:
        string: string
    freeformTags:
        string: string
    kafkaSettings:
        autoCreateTopicsEnable: false
        bootstrapServers: string
        logRetentionHours: 0
        numPartitions: 0
    name: string
    privateEndpointSettings:
        nsgIds:
            - string
        privateEndpointIp: string
        subnetId: string

    StreamPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StreamPool resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    CustomEncryptionKey StreamPoolCustomEncryptionKey
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KafkaSettings StreamPoolKafkaSettings
    (Updatable) Settings for the Kafka compatibility layer.
    Name string
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    PrivateEndpointSettings StreamPoolPrivateEndpointSettings
    Optional parameters if a private stream pool is requested.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    CustomEncryptionKey StreamPoolCustomEncryptionKeyArgs
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KafkaSettings StreamPoolKafkaSettingsArgs
    (Updatable) Settings for the Kafka compatibility layer.
    Name string
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    PrivateEndpointSettings StreamPoolPrivateEndpointSettingsArgs
    Optional parameters if a private stream pool is requested.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the stream.
    customEncryptionKey StreamPoolCustomEncryptionKey
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kafkaSettings StreamPoolKafkaSettings
    (Updatable) Settings for the Kafka compatibility layer.
    name String
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    privateEndpointSettings StreamPoolPrivateEndpointSettings
    Optional parameters if a private stream pool is requested.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    customEncryptionKey StreamPoolCustomEncryptionKey
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kafkaSettings StreamPoolKafkaSettings
    (Updatable) Settings for the Kafka compatibility layer.
    name string
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    privateEndpointSettings StreamPoolPrivateEndpointSettings
    Optional parameters if a private stream pool is requested.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the stream.
    custom_encryption_key streaming.StreamPoolCustomEncryptionKeyArgs
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kafka_settings streaming.StreamPoolKafkaSettingsArgs
    (Updatable) Settings for the Kafka compatibility layer.
    name str
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    private_endpoint_settings streaming.StreamPoolPrivateEndpointSettingsArgs
    Optional parameters if a private stream pool is requested.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the stream.
    customEncryptionKey Property Map
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kafkaSettings Property Map
    (Updatable) Settings for the Kafka compatibility layer.
    name String
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    privateEndpointSettings Property Map
    Optional parameters if a private stream pool is requested.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StreamPool resource produces the following output properties:

    EndpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrivate bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    LifecycleStateDetails string
    Any additional details about the current state of the stream.
    State string
    The current state of the stream pool.
    TimeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    EndpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrivate bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    LifecycleStateDetails string
    Any additional details about the current state of the stream.
    State string
    The current state of the stream pool.
    TimeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    endpointFqdn String
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrivate Boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    lifecycleStateDetails String
    Any additional details about the current state of the stream.
    state String
    The current state of the stream pool.
    timeCreated String
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    endpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    id string
    The provider-assigned unique ID for this managed resource.
    isPrivate boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    lifecycleStateDetails string
    Any additional details about the current state of the stream.
    state string
    The current state of the stream pool.
    timeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    endpoint_fqdn str
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    id str
    The provider-assigned unique ID for this managed resource.
    is_private bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    lifecycle_state_details str
    Any additional details about the current state of the stream.
    state str
    The current state of the stream pool.
    time_created str
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    endpointFqdn String
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrivate Boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    lifecycleStateDetails String
    Any additional details about the current state of the stream.
    state String
    The current state of the stream pool.
    timeCreated String
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Look up Existing StreamPool Resource

    Get an existing StreamPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StreamPoolState, opts?: CustomResourceOptions): StreamPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        custom_encryption_key: Optional[_streaming.StreamPoolCustomEncryptionKeyArgs] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        endpoint_fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_private: Optional[bool] = None,
        kafka_settings: Optional[_streaming.StreamPoolKafkaSettingsArgs] = None,
        lifecycle_state_details: Optional[str] = None,
        name: Optional[str] = None,
        private_endpoint_settings: Optional[_streaming.StreamPoolPrivateEndpointSettingsArgs] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None) -> StreamPool
    func GetStreamPool(ctx *Context, name string, id IDInput, state *StreamPoolState, opts ...ResourceOption) (*StreamPool, error)
    public static StreamPool Get(string name, Input<string> id, StreamPoolState? state, CustomResourceOptions? opts = null)
    public static StreamPool get(String name, Output<String> id, StreamPoolState state, CustomResourceOptions options)
    resources:  _:    type: oci:Streaming:StreamPool    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    CustomEncryptionKey StreamPoolCustomEncryptionKey
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    EndpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsPrivate bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    KafkaSettings StreamPoolKafkaSettings
    (Updatable) Settings for the Kafka compatibility layer.
    LifecycleStateDetails string
    Any additional details about the current state of the stream.
    Name string
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    PrivateEndpointSettings StreamPoolPrivateEndpointSettings
    Optional parameters if a private stream pool is requested.
    State string
    The current state of the stream pool.
    TimeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    CustomEncryptionKey StreamPoolCustomEncryptionKeyArgs
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    EndpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsPrivate bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    KafkaSettings StreamPoolKafkaSettingsArgs
    (Updatable) Settings for the Kafka compatibility layer.
    LifecycleStateDetails string
    Any additional details about the current state of the stream.
    Name string
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    PrivateEndpointSettings StreamPoolPrivateEndpointSettingsArgs
    Optional parameters if a private stream pool is requested.
    State string
    The current state of the stream pool.
    TimeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId String
    (Updatable) The OCID of the compartment that contains the stream.
    customEncryptionKey StreamPoolCustomEncryptionKey
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    endpointFqdn String
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isPrivate Boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafkaSettings StreamPoolKafkaSettings
    (Updatable) Settings for the Kafka compatibility layer.
    lifecycleStateDetails String
    Any additional details about the current state of the stream.
    name String
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    privateEndpointSettings StreamPoolPrivateEndpointSettings
    Optional parameters if a private stream pool is requested.
    state String
    The current state of the stream pool.
    timeCreated String
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    customEncryptionKey StreamPoolCustomEncryptionKey
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    endpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isPrivate boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafkaSettings StreamPoolKafkaSettings
    (Updatable) Settings for the Kafka compatibility layer.
    lifecycleStateDetails string
    Any additional details about the current state of the stream.
    name string
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    privateEndpointSettings StreamPoolPrivateEndpointSettings
    Optional parameters if a private stream pool is requested.
    state string
    The current state of the stream pool.
    timeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartment_id str
    (Updatable) The OCID of the compartment that contains the stream.
    custom_encryption_key streaming.StreamPoolCustomEncryptionKeyArgs
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    endpoint_fqdn str
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_private bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafka_settings streaming.StreamPoolKafkaSettingsArgs
    (Updatable) Settings for the Kafka compatibility layer.
    lifecycle_state_details str
    Any additional details about the current state of the stream.
    name str
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    private_endpoint_settings streaming.StreamPoolPrivateEndpointSettingsArgs
    Optional parameters if a private stream pool is requested.
    state str
    The current state of the stream pool.
    time_created str
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId String
    (Updatable) The OCID of the compartment that contains the stream.
    customEncryptionKey Property Map
    (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    endpointFqdn String
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isPrivate Boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafkaSettings Property Map
    (Updatable) Settings for the Kafka compatibility layer.
    lifecycleStateDetails String
    Any additional details about the current state of the stream.
    name String
    (Updatable) The name of the stream pool. Avoid entering confidential information. Example: MyStreamPool
    privateEndpointSettings Property Map
    Optional parameters if a private stream pool is requested.
    state String
    The current state of the stream pool.
    timeCreated String
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Supporting Types

    StreamPoolCustomEncryptionKey, StreamPoolCustomEncryptionKeyArgs

    KmsKeyId string
    (Updatable) Custom Encryption Key (Master Key) ocid.
    KeyState string
    Life cycle State of the custom key
    KmsKeyId string
    (Updatable) Custom Encryption Key (Master Key) ocid.
    KeyState string
    Life cycle State of the custom key
    kmsKeyId String
    (Updatable) Custom Encryption Key (Master Key) ocid.
    keyState String
    Life cycle State of the custom key
    kmsKeyId string
    (Updatable) Custom Encryption Key (Master Key) ocid.
    keyState string
    Life cycle State of the custom key
    kms_key_id str
    (Updatable) Custom Encryption Key (Master Key) ocid.
    key_state str
    Life cycle State of the custom key
    kmsKeyId String
    (Updatable) Custom Encryption Key (Master Key) ocid.
    keyState String
    Life cycle State of the custom key

    StreamPoolKafkaSettings, StreamPoolKafkaSettingsArgs

    AutoCreateTopicsEnable bool
    (Updatable) Enable auto creation of topic on the server.
    BootstrapServers string
    (Updatable) Bootstrap servers.
    LogRetentionHours int
    (Updatable) The number of hours to keep a log file before deleting it (in hours).
    NumPartitions int
    (Updatable) The default number of log partitions per topic.
    AutoCreateTopicsEnable bool
    (Updatable) Enable auto creation of topic on the server.
    BootstrapServers string
    (Updatable) Bootstrap servers.
    LogRetentionHours int
    (Updatable) The number of hours to keep a log file before deleting it (in hours).
    NumPartitions int
    (Updatable) The default number of log partitions per topic.
    autoCreateTopicsEnable Boolean
    (Updatable) Enable auto creation of topic on the server.
    bootstrapServers String
    (Updatable) Bootstrap servers.
    logRetentionHours Integer
    (Updatable) The number of hours to keep a log file before deleting it (in hours).
    numPartitions Integer
    (Updatable) The default number of log partitions per topic.
    autoCreateTopicsEnable boolean
    (Updatable) Enable auto creation of topic on the server.
    bootstrapServers string
    (Updatable) Bootstrap servers.
    logRetentionHours number
    (Updatable) The number of hours to keep a log file before deleting it (in hours).
    numPartitions number
    (Updatable) The default number of log partitions per topic.
    auto_create_topics_enable bool
    (Updatable) Enable auto creation of topic on the server.
    bootstrap_servers str
    (Updatable) Bootstrap servers.
    log_retention_hours int
    (Updatable) The number of hours to keep a log file before deleting it (in hours).
    num_partitions int
    (Updatable) The default number of log partitions per topic.
    autoCreateTopicsEnable Boolean
    (Updatable) Enable auto creation of topic on the server.
    bootstrapServers String
    (Updatable) Bootstrap servers.
    logRetentionHours Number
    (Updatable) The number of hours to keep a log file before deleting it (in hours).
    numPartitions Number
    (Updatable) The default number of log partitions per topic.

    StreamPoolPrivateEndpointSettings, StreamPoolPrivateEndpointSettingsArgs

    NsgIds List<string>
    The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
    PrivateEndpointIp string
    The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
    SubnetId string

    If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    NsgIds []string
    The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
    PrivateEndpointIp string
    The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
    SubnetId string

    If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    nsgIds List<String>
    The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
    privateEndpointIp String
    The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
    subnetId String

    If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    nsgIds string[]
    The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
    privateEndpointIp string
    The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
    subnetId string

    If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    nsg_ids Sequence[str]
    The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
    private_endpoint_ip str
    The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
    subnet_id str

    If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    nsgIds List<String>
    The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
    privateEndpointIp String
    The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
    subnetId String

    If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    StreamPools can be imported using the id, e.g.

    $ pulumi import oci:Streaming/streamPool:StreamPool test_stream_pool "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci