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

oci.Streaming.Stream

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

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

Starts the provisioning of a new stream. The stream will be created in the given compartment id or stream pool id, depending on which parameter is specified. Compartment id and stream pool id cannot be specified at the same time. To track the progress of the provisioning, you can periodically call GetStream. In the response, the lifecycleState parameter of the Stream object tells you its current state.

Example Usage

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

const testStream = new oci.streaming.Stream("test_stream", {
    name: streamName,
    partitions: streamPartitions,
    compartmentId: compartmentId,
    definedTags: streamDefinedTags,
    freeformTags: {
        Department: "Finance",
    },
    retentionInHours: streamRetentionInHours,
    streamPoolId: testStreamPool.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_stream = oci.streaming.Stream("test_stream",
    name=stream_name,
    partitions=stream_partitions,
    compartment_id=compartment_id,
    defined_tags=stream_defined_tags,
    freeform_tags={
        "Department": "Finance",
    },
    retention_in_hours=stream_retention_in_hours,
    stream_pool_id=test_stream_pool["id"])
Copy
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.NewStream(ctx, "test_stream", &streaming.StreamArgs{
			Name:          pulumi.Any(streamName),
			Partitions:    pulumi.Any(streamPartitions),
			CompartmentId: pulumi.Any(compartmentId),
			DefinedTags:   pulumi.Any(streamDefinedTags),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			RetentionInHours: pulumi.Any(streamRetentionInHours),
			StreamPoolId:     pulumi.Any(testStreamPool.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testStream = new Oci.Streaming.Stream("test_stream", new()
    {
        Name = streamName,
        Partitions = streamPartitions,
        CompartmentId = compartmentId,
        DefinedTags = streamDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        RetentionInHours = streamRetentionInHours,
        StreamPoolId = testStreamPool.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Streaming.Stream;
import com.pulumi.oci.Streaming.StreamArgs;
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 testStream = new Stream("testStream", StreamArgs.builder()
            .name(streamName)
            .partitions(streamPartitions)
            .compartmentId(compartmentId)
            .definedTags(streamDefinedTags)
            .freeformTags(Map.of("Department", "Finance"))
            .retentionInHours(streamRetentionInHours)
            .streamPoolId(testStreamPool.id())
            .build());

    }
}
Copy
resources:
  testStream:
    type: oci:Streaming:Stream
    name: test_stream
    properties:
      name: ${streamName}
      partitions: ${streamPartitions}
      compartmentId: ${compartmentId}
      definedTags: ${streamDefinedTags}
      freeformTags:
        Department: Finance
      retentionInHours: ${streamRetentionInHours}
      streamPoolId: ${testStreamPool.id}
Copy

Create Stream Resource

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

Constructor syntax

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

@overload
def Stream(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           partitions: Optional[int] = None,
           compartment_id: Optional[str] = None,
           defined_tags: Optional[Mapping[str, str]] = None,
           freeform_tags: Optional[Mapping[str, str]] = None,
           name: Optional[str] = None,
           retention_in_hours: Optional[int] = None,
           stream_pool_id: Optional[str] = None)
func NewStream(ctx *Context, name string, args StreamArgs, opts ...ResourceOption) (*Stream, error)
public Stream(string name, StreamArgs args, CustomResourceOptions? opts = null)
public Stream(String name, StreamArgs args)
public Stream(String name, StreamArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StreamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StreamArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StreamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StreamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StreamArgs
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 streamResource = new Oci.Streaming.Stream("streamResource", new()
{
    Partitions = 0,
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    Name = "string",
    RetentionInHours = 0,
    StreamPoolId = "string",
});
Copy
example, err := Streaming.NewStream(ctx, "streamResource", &Streaming.StreamArgs{
	Partitions:    pulumi.Int(0),
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:             pulumi.String("string"),
	RetentionInHours: pulumi.Int(0),
	StreamPoolId:     pulumi.String("string"),
})
Copy
var streamResource = new Stream("streamResource", StreamArgs.builder()
    .partitions(0)
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .name("string")
    .retentionInHours(0)
    .streamPoolId("string")
    .build());
Copy
stream_resource = oci.streaming.Stream("streamResource",
    partitions=0,
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    name="string",
    retention_in_hours=0,
    stream_pool_id="string")
Copy
const streamResource = new oci.streaming.Stream("streamResource", {
    partitions: 0,
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    name: "string",
    retentionInHours: 0,
    streamPoolId: "string",
});
Copy
type: oci:Streaming:Stream
properties:
    compartmentId: string
    definedTags:
        string: string
    freeformTags:
        string: string
    name: string
    partitions: 0
    retentionInHours: 0
    streamPoolId: string
Copy

Stream 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 Stream resource accepts the following input properties:

Partitions
This property is required.
Changes to this property will trigger replacement.
int
The number of partitions in the stream.
CompartmentId string
(Updatable) The OCID of the compartment that contains the stream.
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"}
Name Changes to this property will trigger replacement. string
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
RetentionInHours Changes to this property will trigger replacement. int
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
StreamPoolId string

(Updatable) The OCID of the stream pool that contains the stream.

** 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

Partitions
This property is required.
Changes to this property will trigger replacement.
int
The number of partitions in the stream.
CompartmentId string
(Updatable) The OCID of the compartment that contains the stream.
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"}
Name Changes to this property will trigger replacement. string
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
RetentionInHours Changes to this property will trigger replacement. int
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
StreamPoolId string

(Updatable) The OCID of the stream pool that contains the stream.

** 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

partitions
This property is required.
Changes to this property will trigger replacement.
Integer
The number of partitions in the stream.
compartmentId String
(Updatable) The OCID of the compartment that contains the stream.
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"}
name Changes to this property will trigger replacement. String
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
retentionInHours Changes to this property will trigger replacement. Integer
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
streamPoolId String

(Updatable) The OCID of the stream pool that contains the stream.

** 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

partitions
This property is required.
Changes to this property will trigger replacement.
number
The number of partitions in the stream.
compartmentId string
(Updatable) The OCID of the compartment that contains the stream.
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"}
name Changes to this property will trigger replacement. string
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
retentionInHours Changes to this property will trigger replacement. number
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
streamPoolId string

(Updatable) The OCID of the stream pool that contains the stream.

** 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

partitions
This property is required.
Changes to this property will trigger replacement.
int
The number of partitions in the stream.
compartment_id str
(Updatable) The OCID of the compartment that contains the stream.
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"}
name Changes to this property will trigger replacement. str
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
retention_in_hours Changes to this property will trigger replacement. int
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
stream_pool_id str

(Updatable) The OCID of the stream pool that contains the stream.

** 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

partitions
This property is required.
Changes to this property will trigger replacement.
Number
The number of partitions in the stream.
compartmentId String
(Updatable) The OCID of the compartment that contains the stream.
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"}
name Changes to this property will trigger replacement. String
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
retentionInHours Changes to this property will trigger replacement. Number
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
streamPoolId String

(Updatable) The OCID of the stream pool that contains the stream.

** 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

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
LifecycleStateDetails string
Any additional details about the current state of the stream.
MessagesEndpoint string
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
State string
The current state of the stream.
TimeCreated string
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
Id string
The provider-assigned unique ID for this managed resource.
LifecycleStateDetails string
Any additional details about the current state of the stream.
MessagesEndpoint string
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
State string
The current state of the stream.
TimeCreated string
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
id String
The provider-assigned unique ID for this managed resource.
lifecycleStateDetails String
Any additional details about the current state of the stream.
messagesEndpoint String
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
state String
The current state of the stream.
timeCreated String
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
id string
The provider-assigned unique ID for this managed resource.
lifecycleStateDetails string
Any additional details about the current state of the stream.
messagesEndpoint string
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
state string
The current state of the stream.
timeCreated string
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
id str
The provider-assigned unique ID for this managed resource.
lifecycle_state_details str
Any additional details about the current state of the stream.
messages_endpoint str
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
state str
The current state of the stream.
time_created str
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
id String
The provider-assigned unique ID for this managed resource.
lifecycleStateDetails String
Any additional details about the current state of the stream.
messagesEndpoint String
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
state String
The current state of the stream.
timeCreated String
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

Look up Existing Stream Resource

Get an existing Stream 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?: StreamState, opts?: CustomResourceOptions): Stream
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_state_details: Optional[str] = None,
        messages_endpoint: Optional[str] = None,
        name: Optional[str] = None,
        partitions: Optional[int] = None,
        retention_in_hours: Optional[int] = None,
        state: Optional[str] = None,
        stream_pool_id: Optional[str] = None,
        time_created: Optional[str] = None) -> Stream
func GetStream(ctx *Context, name string, id IDInput, state *StreamState, opts ...ResourceOption) (*Stream, error)
public static Stream Get(string name, Input<string> id, StreamState? state, CustomResourceOptions? opts = null)
public static Stream get(String name, Output<String> id, StreamState state, CustomResourceOptions options)
resources:  _:    type: oci:Streaming:Stream    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
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"}
LifecycleStateDetails string
Any additional details about the current state of the stream.
MessagesEndpoint string
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
Name Changes to this property will trigger replacement. string
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
Partitions Changes to this property will trigger replacement. int
The number of partitions in the stream.
RetentionInHours Changes to this property will trigger replacement. int
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
State string
The current state of the stream.
StreamPoolId string

(Updatable) The OCID of the stream pool that contains the stream.

** 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

TimeCreated string
The date and time the stream 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.
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"}
LifecycleStateDetails string
Any additional details about the current state of the stream.
MessagesEndpoint string
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
Name Changes to this property will trigger replacement. string
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
Partitions Changes to this property will trigger replacement. int
The number of partitions in the stream.
RetentionInHours Changes to this property will trigger replacement. int
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
State string
The current state of the stream.
StreamPoolId string

(Updatable) The OCID of the stream pool that contains the stream.

** 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

TimeCreated string
The date and time the stream 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.
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"}
lifecycleStateDetails String
Any additional details about the current state of the stream.
messagesEndpoint String
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
name Changes to this property will trigger replacement. String
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
partitions Changes to this property will trigger replacement. Integer
The number of partitions in the stream.
retentionInHours Changes to this property will trigger replacement. Integer
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
state String
The current state of the stream.
streamPoolId String

(Updatable) The OCID of the stream pool that contains the stream.

** 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

timeCreated String
The date and time the stream 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.
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"}
lifecycleStateDetails string
Any additional details about the current state of the stream.
messagesEndpoint string
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
name Changes to this property will trigger replacement. string
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
partitions Changes to this property will trigger replacement. number
The number of partitions in the stream.
retentionInHours Changes to this property will trigger replacement. number
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
state string
The current state of the stream.
streamPoolId string

(Updatable) The OCID of the stream pool that contains the stream.

** 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

timeCreated string
The date and time the stream 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.
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"}
lifecycle_state_details str
Any additional details about the current state of the stream.
messages_endpoint str
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
name Changes to this property will trigger replacement. str
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
partitions Changes to this property will trigger replacement. int
The number of partitions in the stream.
retention_in_hours Changes to this property will trigger replacement. int
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
state str
The current state of the stream.
stream_pool_id str

(Updatable) The OCID of the stream pool that contains the stream.

** 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

time_created str
The date and time the stream 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.
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"}
lifecycleStateDetails String
Any additional details about the current state of the stream.
messagesEndpoint String
The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
name Changes to this property will trigger replacement. String
The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
partitions Changes to this property will trigger replacement. Number
The number of partitions in the stream.
retentionInHours Changes to this property will trigger replacement. Number
The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours.
state String
The current state of the stream.
streamPoolId String

(Updatable) The OCID of the stream pool that contains the stream.

** 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

timeCreated String
The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

Import

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

$ pulumi import oci:Streaming/stream:Stream test_stream "id"
Copy

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.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci