Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.Streaming.getStream
Explore with Pulumi AI
This data source provides details about a specific Stream resource in Oracle Cloud Infrastructure Streaming service.
Gets detailed information about a stream, including the number of partitions.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testStream = oci.Streaming.getStream({
streamId: testStreamOciStreamingStream.id,
});
import pulumi
import pulumi_oci as oci
test_stream = oci.Streaming.get_stream(stream_id=test_stream_oci_streaming_stream["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.GetStream(ctx, &streaming.GetStreamArgs{
StreamId: testStreamOciStreamingStream.Id,
}, nil)
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 = Oci.Streaming.GetStream.Invoke(new()
{
StreamId = testStreamOciStreamingStream.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Streaming.StreamingFunctions;
import com.pulumi.oci.Streaming.inputs.GetStreamArgs;
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) {
final var testStream = StreamingFunctions.getStream(GetStreamArgs.builder()
.streamId(testStreamOciStreamingStream.id())
.build());
}
}
variables:
testStream:
fn::invoke:
Function: oci:Streaming:getStream
Arguments:
streamId: ${testStreamOciStreamingStream.id}
Using getStream
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getStream(args: GetStreamArgs, opts?: InvokeOptions): Promise<GetStreamResult>
function getStreamOutput(args: GetStreamOutputArgs, opts?: InvokeOptions): Output<GetStreamResult>
def get_stream(stream_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamResult
def get_stream_output(stream_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamResult]
func GetStream(ctx *Context, args *GetStreamArgs, opts ...InvokeOption) (*GetStreamResult, error)
func GetStreamOutput(ctx *Context, args *GetStreamOutputArgs, opts ...InvokeOption) GetStreamResultOutput
> Note: This function is named GetStream
in the Go SDK.
public static class GetStream
{
public static Task<GetStreamResult> InvokeAsync(GetStreamArgs args, InvokeOptions? opts = null)
public static Output<GetStreamResult> Invoke(GetStreamInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Streaming/getStream:getStream
arguments:
# arguments dictionary
The following arguments are supported:
- Stream
Id string - The OCID of the stream.
- Stream
Id string - The OCID of the stream.
- stream
Id String - The OCID of the stream.
- stream
Id string - The OCID of the stream.
- stream_
id str - The OCID of the stream.
- stream
Id String - The OCID of the stream.
getStream Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment that contains the stream.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}'
- Dictionary<string, string>
- 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"}
- Id string
- The OCID of the stream.
- Lifecycle
State stringDetails - Any additional details about the current state of the stream.
- Messages
Endpoint 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.
- Retention
In intHours - The retention period of the stream, in hours. This property is read-only.
- State string
- The current state of the stream.
- Stream
Id string - Stream
Pool stringId - The OCID of the stream pool that contains the stream.
- Time
Created 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 string - The OCID of the compartment that contains the stream.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}'
- map[string]string
- 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"}
- Id string
- The OCID of the stream.
- Lifecycle
State stringDetails - Any additional details about the current state of the stream.
- Messages
Endpoint 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.
- Retention
In intHours - The retention period of the stream, in hours. This property is read-only.
- State string
- The current state of the stream.
- Stream
Id string - Stream
Pool stringId - The OCID of the stream pool that contains the stream.
- Time
Created 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 String - The OCID of the compartment that contains the stream.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}'
- Map<String,String>
- 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"}
- id String
- The OCID of the stream.
- lifecycle
State StringDetails - Any additional details about the current state of the stream.
- messages
Endpoint 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.
- retention
In IntegerHours - The retention period of the stream, in hours. This property is read-only.
- state String
- The current state of the stream.
- stream
Id String - stream
Pool StringId - The OCID of the stream pool that contains the stream.
- time
Created 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 string - The OCID of the compartment that contains the stream.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}'
- {[key: string]: string}
- 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"}
- id string
- The OCID of the stream.
- lifecycle
State stringDetails - Any additional details about the current state of the stream.
- messages
Endpoint 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.
- retention
In numberHours - The retention period of the stream, in hours. This property is read-only.
- state string
- The current state of the stream.
- stream
Id string - stream
Pool stringId - The OCID of the stream pool that contains the stream.
- time
Created 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 - The OCID of the compartment that contains the stream.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}'
- Mapping[str, str]
- 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"}
- id str
- The OCID of the stream.
- lifecycle_
state_ strdetails - 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_ inthours - The retention period of the stream, in hours. This property is read-only.
- state str
- The current state of the stream.
- stream_
id str - stream_
pool_ strid - The OCID of the stream pool that contains 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
- compartment
Id String - The OCID of the compartment that contains the stream.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}'
- Map<String>
- 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"}
- id String
- The OCID of the stream.
- lifecycle
State StringDetails - Any additional details about the current state of the stream.
- messages
Endpoint 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.
- retention
In NumberHours - The retention period of the stream, in hours. This property is read-only.
- state String
- The current state of the stream.
- stream
Id String - stream
Pool StringId - The OCID of the stream pool that contains the stream.
- time
Created String - The date and time the stream was created, expressed in in RFC 3339 timestamp format. Example:
2018-04-20T00:00:07.405Z
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.