1. Packages
  2. Ibm Provider
  3. API Docs
  4. getLogsStreams
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getLogsStreams

Explore with Pulumi AI

Provides a read-only data source to retrieve information about logs_streams. 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 logsStreams = ibm.getLogsStreams({
    instanceId: ibm_resource_instance.logs_instance.guid,
    region: ibm_resource_instance.logs_instance.location,
});
Copy
import pulumi
import pulumi_ibm as ibm

logs_streams = ibm.get_logs_streams(instance_id=ibm_resource_instance["logs_instance"]["guid"],
    region=ibm_resource_instance["logs_instance"]["location"])
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.GetLogsStreams(ctx, &ibm.GetLogsStreamsArgs{
			InstanceId: ibm_resource_instance.Logs_instance.Guid,
			Region:     pulumi.StringRef(ibm_resource_instance.Logs_instance.Location),
		}, 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 logsStreams = Ibm.GetLogsStreams.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Logs_instance.Guid,
        Region = ibm_resource_instance.Logs_instance.Location,
    });

});
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.GetLogsStreamsArgs;
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 logsStreams = IbmFunctions.getLogsStreams(GetLogsStreamsArgs.builder()
            .instanceId(ibm_resource_instance.logs_instance().guid())
            .region(ibm_resource_instance.logs_instance().location())
            .build());

    }
}
Copy
variables:
  logsStreams:
    fn::invoke:
      function: ibm:getLogsStreams
      arguments:
        instanceId: ${ibm_resource_instance.logs_instance.guid}
        region: ${ibm_resource_instance.logs_instance.location}
Copy

Using getLogsStreams

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 getLogsStreams(args: GetLogsStreamsArgs, opts?: InvokeOptions): Promise<GetLogsStreamsResult>
function getLogsStreamsOutput(args: GetLogsStreamsOutputArgs, opts?: InvokeOptions): Output<GetLogsStreamsResult>
Copy
def get_logs_streams(endpoint_type: Optional[str] = None,
                     id: Optional[str] = None,
                     instance_id: Optional[str] = None,
                     region: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetLogsStreamsResult
def get_logs_streams_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     instance_id: Optional[pulumi.Input[str]] = None,
                     region: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetLogsStreamsResult]
Copy
func GetLogsStreams(ctx *Context, args *GetLogsStreamsArgs, opts ...InvokeOption) (*GetLogsStreamsResult, error)
func GetLogsStreamsOutput(ctx *Context, args *GetLogsStreamsOutputArgs, opts ...InvokeOption) GetLogsStreamsResultOutput
Copy

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

public static class GetLogsStreams 
{
    public static Task<GetLogsStreamsResult> InvokeAsync(GetLogsStreamsArgs args, InvokeOptions? opts = null)
    public static Output<GetLogsStreamsResult> Invoke(GetLogsStreamsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLogsStreamsResult> getLogsStreams(GetLogsStreamsArgs args, InvokeOptions options)
public static Output<GetLogsStreamsResult> getLogsStreams(GetLogsStreamsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getLogsStreams:getLogsStreams
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
Cloud Logs Instance GUID.
EndpointType string
Id string
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
Region string
Cloud Logs Instance Region.
InstanceId This property is required. string
Cloud Logs Instance GUID.
EndpointType string
Id string
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
Region string
Cloud Logs Instance Region.
instanceId This property is required. String
Cloud Logs Instance GUID.
endpointType String
id String
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
region String
Cloud Logs Instance Region.
instanceId This property is required. string
Cloud Logs Instance GUID.
endpointType string
id string
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
region string
Cloud Logs Instance Region.
instance_id This property is required. str
Cloud Logs Instance GUID.
endpoint_type str
id str
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
region str
Cloud Logs Instance Region.
instanceId This property is required. String
Cloud Logs Instance GUID.
endpointType String
id String
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
region String
Cloud Logs Instance Region.

getLogsStreams Result

The following output properties are available:

Id string
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
InstanceId string
Region string
Streams List<GetLogsStreamsStream>
(List) Collection of Event Streams.

  • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for streams:
EndpointType string
Id string
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
InstanceId string
Region string
Streams []GetLogsStreamsStream
(List) Collection of Event Streams.

  • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for streams:
EndpointType string
id String
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
instanceId String
region String
streams List<GetLogsStreamsStream>
(List) Collection of Event Streams.

  • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for streams:
endpointType String
id string
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
instanceId string
region string
streams GetLogsStreamsStream[]
(List) Collection of Event Streams.

  • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for streams:
endpointType string
id str
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
instance_id str
region str
streams Sequence[GetLogsStreamsStream]
(List) Collection of Event Streams.

  • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for streams:
endpoint_type str
id String
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
instanceId String
region String
streams List<Property Map>
(List) Collection of Event Streams.

  • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for streams:
endpointType String

Supporting Types

GetLogsStreamsStream

CompressionType This property is required. string
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
CreatedAt This property is required. string
(String) The creation time of the Event stream.
DpxlExpression This property is required. 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 This property is required. List<GetLogsStreamsStreamIbmEventStream>
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
Id This property is required. double
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
IsActive This property is required. bool
(Boolean) Whether the Event stream is active.
Name This property is required. 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}]+$/.
UpdatedAt This property is required. string
(String) The update time of the Event stream.
CompressionType This property is required. string
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
CreatedAt This property is required. string
(String) The creation time of the Event stream.
DpxlExpression This property is required. 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 This property is required. []GetLogsStreamsStreamIbmEventStream
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
Id This property is required. float64
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
IsActive This property is required. bool
(Boolean) Whether the Event stream is active.
Name This property is required. 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}]+$/.
UpdatedAt This property is required. string
(String) The update time of the Event stream.
compressionType This property is required. String
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
createdAt This property is required. String
(String) The creation time of the Event stream.
dpxlExpression This property is required. 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 This property is required. List<GetLogsStreamsStreamIbmEventStream>
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id This property is required. Double
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
isActive This property is required. Boolean
(Boolean) Whether the Event stream is active.
name This property is required. 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}]+$/.
updatedAt This property is required. String
(String) The update time of the Event stream.
compressionType This property is required. string
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
createdAt This property is required. string
(String) The creation time of the Event stream.
dpxlExpression This property is required. 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 This property is required. GetLogsStreamsStreamIbmEventStream[]
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id This property is required. number
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
isActive This property is required. boolean
(Boolean) Whether the Event stream is active.
name This property is required. 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}]+$/.
updatedAt This property is required. string
(String) The update time of the Event stream.
compression_type This property is required. str
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
created_at This property is required. str
(String) The creation time of the Event stream.
dpxl_expression This property is required. 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 This property is required. Sequence[GetLogsStreamsStreamIbmEventStream]
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id This property is required. float
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
is_active This property is required. bool
(Boolean) Whether the Event stream is active.
name This property is required. 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}]+$/.
updated_at This property is required. str
(String) The update time of the Event stream.
compressionType This property is required. String
(String) The compression type of the stream.

  • Constraints: Allowable values are: unspecified, gzip.
createdAt This property is required. String
(String) The creation time of the Event stream.
dpxlExpression This property is required. 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 This property is required. List<Property Map>
(List) Configuration for IBM Event Streams. Nested schema for ibm_event_streams:
id This property is required. Number
(Integer) The ID of the Event stream.

  • Constraints: The maximum value is 4294967295. The minimum value is 0.
isActive This property is required. Boolean
(Boolean) Whether the Event stream is active.
name This property is required. 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}]+$/.
updatedAt This property is required. String
(String) The update time of the Event stream.

GetLogsStreamsStreamIbmEventStream

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.