Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getLogsStream
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getLogsStream

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a read-only data source to retrieve information about a logs_stream. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

Example Usage

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

const logsStream = ibm.getLogsStream({
    instanceId: ibm_logs_stream.logs_stream_instance.instance_id,
    region: ibm_logs_stream.logs_stream_instance.region,
    logsStreamsId: ibm_logs_stream.logs_stream_instance.streams_id,
});
Copy
import pulumi
import pulumi_ibm as ibm

logs_stream = ibm.get_logs_stream(instance_id=ibm_logs_stream["logs_stream_instance"]["instance_id"],
    region=ibm_logs_stream["logs_stream_instance"]["region"],
    logs_streams_id=ibm_logs_stream["logs_stream_instance"]["streams_id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupLogsStream(ctx, &ibm.LookupLogsStreamArgs{
			InstanceId:    ibm_logs_stream.Logs_stream_instance.Instance_id,
			Region:        pulumi.StringRef(ibm_logs_stream.Logs_stream_instance.Region),
			LogsStreamsId: ibm_logs_stream.Logs_stream_instance.Streams_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var logsStream = Ibm.GetLogsStream.Invoke(new()
    {
        InstanceId = ibm_logs_stream.Logs_stream_instance.Instance_id,
        Region = ibm_logs_stream.Logs_stream_instance.Region,
        LogsStreamsId = ibm_logs_stream.Logs_stream_instance.Streams_id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetLogsStreamArgs;
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 logsStream = IbmFunctions.getLogsStream(GetLogsStreamArgs.builder()
            .instanceId(ibm_logs_stream.logs_stream_instance().instance_id())
            .region(ibm_logs_stream.logs_stream_instance().region())
            .logsStreamsId(ibm_logs_stream.logs_stream_instance().streams_id())
            .build());

    }
}
Copy
variables:
  logsStream:
    fn::invoke:
      function: ibm:getLogsStream
      arguments:
        instanceId: ${ibm_logs_stream.logs_stream_instance.instance_id}
        region: ${ibm_logs_stream.logs_stream_instance.region}
        logsStreamsId: ${ibm_logs_stream.logs_stream_instance.streams_id}
Copy

Using getLogsStream

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 getLogsStream(args: GetLogsStreamArgs, opts?: InvokeOptions): Promise<GetLogsStreamResult>
function getLogsStreamOutput(args: GetLogsStreamOutputArgs, opts?: InvokeOptions): Output<GetLogsStreamResult>
Copy
def get_logs_stream(endpoint_type: Optional[str] = None,
                    id: Optional[str] = None,
                    instance_id: Optional[str] = None,
                    logs_streams_id: Optional[str] = None,
                    region: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetLogsStreamResult
def get_logs_stream_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    instance_id: Optional[pulumi.Input[str]] = None,
                    logs_streams_id: Optional[pulumi.Input[str]] = None,
                    region: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetLogsStreamResult]
Copy
func LookupLogsStream(ctx *Context, args *LookupLogsStreamArgs, opts ...InvokeOption) (*LookupLogsStreamResult, error)
func LookupLogsStreamOutput(ctx *Context, args *LookupLogsStreamOutputArgs, opts ...InvokeOption) LookupLogsStreamResultOutput
Copy

> Note: This function is named LookupLogsStream in the Go SDK.

public static class GetLogsStream 
{
    public static Task<GetLogsStreamResult> InvokeAsync(GetLogsStreamArgs args, InvokeOptions? opts = null)
    public static Output<GetLogsStreamResult> Invoke(GetLogsStreamInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLogsStreamResult> getLogsStream(GetLogsStreamArgs args, InvokeOptions options)
public static Output<GetLogsStreamResult> getLogsStream(GetLogsStreamArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getLogsStream:getLogsStream
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
Cloud Logs Instance GUID.
LogsStreamsId This property is required. string
Streams ID.
EndpointType string
Id string
The unique identifier of the logs_stream.
Region string
Cloud Logs Instance Region.
InstanceId This property is required. string
Cloud Logs Instance GUID.
LogsStreamsId This property is required. string
Streams ID.
EndpointType string
Id string
The unique identifier of the logs_stream.
Region string
Cloud Logs Instance Region.
instanceId This property is required. String
Cloud Logs Instance GUID.
logsStreamsId This property is required. String
Streams ID.
endpointType String
id String
The unique identifier of the logs_stream.
region String
Cloud Logs Instance Region.
instanceId This property is required. string
Cloud Logs Instance GUID.
logsStreamsId This property is required. string
Streams ID.
endpointType string
id string
The unique identifier of the logs_stream.
region string
Cloud Logs Instance Region.
instance_id This property is required. str
Cloud Logs Instance GUID.
logs_streams_id This property is required. str
Streams ID.
endpoint_type str
id str
The unique identifier of the logs_stream.
region str
Cloud Logs Instance Region.
instanceId This property is required. String
Cloud Logs Instance GUID.
logsStreamsId This property is required. String
Streams ID.
endpointType String
id String
The unique identifier of the logs_stream.
region String
Cloud Logs Instance Region.

getLogsStream Result

The following output properties are available:

CompressionType string
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
CreatedAt string
(String) The creation time of the Event stream.
DpxlExpression string
(String) The DPXL expression of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
IbmEventStreams List<GetLogsStreamIbmEventStream>
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
Id string
The unique identifier of the logs_stream.
InstanceId string
IsActive bool
(Boolean) Whether the Event stream is active.
LogsStreamsId string
Name string
(String) The name of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
Region string
UpdatedAt string
(String) The update time of the Event stream.
EndpointType string
CompressionType string
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
CreatedAt string
(String) The creation time of the Event stream.
DpxlExpression string
(String) The DPXL expression of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
IbmEventStreams []GetLogsStreamIbmEventStream
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
Id string
The unique identifier of the logs_stream.
InstanceId string
IsActive bool
(Boolean) Whether the Event stream is active.
LogsStreamsId string
Name string
(String) The name of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
Region string
UpdatedAt string
(String) The update time of the Event stream.
EndpointType string
compressionType String
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
createdAt String
(String) The creation time of the Event stream.
dpxlExpression String
(String) The DPXL expression of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
ibmEventStreams List<GetLogsStreamIbmEventStream>
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id String
The unique identifier of the logs_stream.
instanceId String
isActive Boolean
(Boolean) Whether the Event stream is active.
logsStreamsId String
name String
(String) The name of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
region String
updatedAt String
(String) The update time of the Event stream.
endpointType String
compressionType string
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
createdAt string
(String) The creation time of the Event stream.
dpxlExpression string
(String) The DPXL expression of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
ibmEventStreams GetLogsStreamIbmEventStream[]
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id string
The unique identifier of the logs_stream.
instanceId string
isActive boolean
(Boolean) Whether the Event stream is active.
logsStreamsId string
name string
(String) The name of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
region string
updatedAt string
(String) The update time of the Event stream.
endpointType string
compression_type str
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
created_at str
(String) The creation time of the Event stream.
dpxl_expression str
(String) The DPXL expression of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
ibm_event_streams Sequence[GetLogsStreamIbmEventStream]
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id str
The unique identifier of the logs_stream.
instance_id str
is_active bool
(Boolean) Whether the Event stream is active.
logs_streams_id str
name str
(String) The name of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
region str
updated_at str
(String) The update time of the Event stream.
endpoint_type str
compressionType String
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
createdAt String
(String) The creation time of the Event stream.
dpxlExpression String
(String) The DPXL expression of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
ibmEventStreams List<Property Map>
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id String
The unique identifier of the logs_stream.
instanceId String
isActive Boolean
(Boolean) Whether the Event stream is active.
logsStreamsId String
name String
(String) The name of the Event stream.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
region String
updatedAt String
(String) The update time of the Event stream.
endpointType String

Supporting Types

GetLogsStreamIbmEventStream

Brokers This property is required. string
(String) The brokers of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
Topic This property is required. string
(String) The topic of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
Brokers This property is required. string
(String) The brokers of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
Topic This property is required. string
(String) The topic of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
brokers This property is required. String
(String) The brokers of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
topic This property is required. String
(String) The topic of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
brokers This property is required. string
(String) The brokers of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
topic This property is required. string
(String) The topic of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
brokers This property is required. str
(String) The brokers of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
topic This property is required. str
(String) The topic of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
brokers This property is required. String
(String) The brokers of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.
topic This property is required. String
(String) The topic of the IBM Event Streams.

  • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression /^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$/.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm