Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Streaming
  5. Stream
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Streaming.Stream

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 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,
});

    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"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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.Map{
				"Department": pulumi.Any("Finance"),
			},
			RetentionInHours: pulumi.Any(streamRetentionInHours),
			StreamPoolId:     pulumi.Any(testStreamPool.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 testStream = new Oci.Streaming.Stream("test_stream", new()
    {
        Name = streamName,
        Partitions = streamPartitions,
        CompartmentId = compartmentId,
        DefinedTags = streamDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        RetentionInHours = streamRetentionInHours,
        StreamPoolId = testStreamPool.Id,
    });

});

    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());

    }
}

    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}

    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, Any]] = None,
           freeform_tags: Optional[Mapping[str, Any]] = 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 string
    The unique name of the resource.
    args StreamArgs
    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 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 string
    The unique name of the resource.
    args StreamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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", "any" },
    },
    FreeformTags = 
    {
        { "string", "any" },
    },
    Name = "string",
    RetentionInHours = 0,
    StreamPoolId = "string",
});

    example, err := Streaming.NewStream(ctx, "streamResource", &Streaming.StreamArgs{
	Partitions:    pulumi.Int(0),
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Name:             pulumi.String("string"),
	RetentionInHours: pulumi.Int(0),
	StreamPoolId:     pulumi.String("string"),
})

    var streamResource = new Stream("streamResource", StreamArgs.builder()
    .partitions(0)
    .compartmentId("string")
    .definedTags(Map.of("string", "any"))
    .freeformTags(Map.of("string", "any"))
    .name("string")
    .retentionInHours(0)
    .streamPoolId("string")
    .build());

    stream_resource = oci.streaming.Stream("streamResource",
    partitions=0,
    compartment_id="string",
    defined_tags={
        "string": "any",
    },
    freeform_tags={
        "string": "any",
    },
    name="string",
    retention_in_hours=0,
    stream_pool_id="string")

    const streamResource = new oci.streaming.Stream("streamResource", {
    partitions: 0,
    compartmentId: "string",
    definedTags: {
        string: "any",
    },
    freeformTags: {
        string: "any",
    },
    name: "string",
    retentionInHours: 0,
    streamPoolId: "string",
});

    type: oci:Streaming:Stream
properties:
    compartmentId: string
    definedTags:
        string: any
    freeformTags:
        string: any
    name: string
    partitions: 0
    retentionInHours: 0
    streamPoolId: string

    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

    The Stream resource accepts the following input properties:

    Partitions int
    The number of partitions in the stream.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    DefinedTags Dictionary<string, object>
    (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, object>
    (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 string
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    RetentionInHours 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 int
    The number of partitions in the stream.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    DefinedTags map[string]interface{}
    (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]interface{}
    (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 string
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    RetentionInHours 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 Integer
    The number of partitions in the stream.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the stream.
    definedTags Map<String,Object>
    (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,Object>
    (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 String
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    retentionInHours 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 number
    The number of partitions in the stream.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the stream.
    definedTags {[key: string]: any}
    (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]: any}
    (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 string
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    retentionInHours 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 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, Any]
    (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, Any]
    (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 str
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    retention_in_hours 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 Number
    The number of partitions in the stream.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the stream.
    definedTags Map<Any>
    (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<Any>
    (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 String
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    retentionInHours 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, Any]] = None,
        freeform_tags: Optional[Mapping[str, Any]] = 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)
    Resource lookup is not supported in YAML
    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.
    DefinedTags Dictionary<string, object>
    (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, object>
    (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 string
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    Partitions int
    The number of partitions in the stream.
    RetentionInHours 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]interface{}
    (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]interface{}
    (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 string
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    Partitions int
    The number of partitions in the stream.
    RetentionInHours 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,Object>
    (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,Object>
    (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 String
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    partitions Integer
    The number of partitions in the stream.
    retentionInHours 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]: any}
    (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]: any}
    (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 string
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    partitions number
    The number of partitions in the stream.
    retentionInHours 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, Any]
    (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, Any]
    (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 str
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    partitions int
    The number of partitions in the stream.
    retention_in_hours 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<Any>
    (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<Any>
    (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 String
    The name of the stream. Avoid entering confidential information. Example: TelemetryEvents
    partitions Number
    The number of partitions in the stream.
    retentionInHours 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"

    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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci