1. Packages
  2. Okta
  3. API Docs
  4. Index
  5. getLogStream
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

okta.Index.getLogStream

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

    Use this data source to retrieve a log stream from Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.Index.getLogStream({
        name: "Example Stream",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.Index.get_log_stream(name="Example Stream")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/Index"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Index.GetLogStream(ctx, &index.GetLogStreamArgs{
    			Name: pulumi.StringRef("Example Stream"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.Index.GetLogStream.Invoke(new()
        {
            Name = "Example Stream",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.Index.IndexFunctions;
    import com.pulumi.okta.Index.inputs.GetLogStreamArgs;
    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 example = IndexFunctions.getLogStream(GetLogStreamArgs.builder()
                .name("Example Stream")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: okta:Index:getLogStream
          Arguments:
            name: Example Stream
    

    Using getLogStream

    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 getLogStream(args: GetLogStreamArgs, opts?: InvokeOptions): Promise<GetLogStreamResult>
    function getLogStreamOutput(args: GetLogStreamOutputArgs, opts?: InvokeOptions): Output<GetLogStreamResult>
    def get_log_stream(id: Optional[str] = None,
                       name: Optional[str] = None,
                       settings: Optional[_index.GetLogStreamSettings] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLogStreamResult
    def get_log_stream_output(id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       settings: Optional[pulumi.Input[_index.GetLogStreamSettingsArgs]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLogStreamResult]
    func GetLogStream(ctx *Context, args *GetLogStreamArgs, opts ...InvokeOption) (*GetLogStreamResult, error)
    func GetLogStreamOutput(ctx *Context, args *GetLogStreamOutputArgs, opts ...InvokeOption) GetLogStreamResultOutput

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

    public static class GetLogStream 
    {
        public static Task<GetLogStreamResult> InvokeAsync(GetLogStreamArgs args, InvokeOptions? opts = null)
        public static Output<GetLogStreamResult> Invoke(GetLogStreamInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLogStreamResult> getLogStream(GetLogStreamArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:Index/getLogStream:getLogStream
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the log stream to retrieve, conflicts with name.
    Name string
    Name of the log stream to retrieve, conflicts with id.
    Settings GetLogStreamSettings
    Provider specific configuration.
    Id string
    ID of the log stream to retrieve, conflicts with name.
    Name string
    Name of the log stream to retrieve, conflicts with id.
    Settings GetLogStreamSettings
    Provider specific configuration.
    id String
    ID of the log stream to retrieve, conflicts with name.
    name String
    Name of the log stream to retrieve, conflicts with id.
    settings GetLogStreamSettings
    Provider specific configuration.
    id string
    ID of the log stream to retrieve, conflicts with name.
    name string
    Name of the log stream to retrieve, conflicts with id.
    settings GetLogStreamSettings
    Provider specific configuration.
    id str
    ID of the log stream to retrieve, conflicts with name.
    name str
    Name of the log stream to retrieve, conflicts with id.
    settings index.GetLogStreamSettings
    Provider specific configuration.
    id String
    ID of the log stream to retrieve, conflicts with name.
    name String
    Name of the log stream to retrieve, conflicts with id.
    settings Property Map
    Provider specific configuration.

    getLogStream Result

    The following output properties are available:

    Status string
    Log Stream Status - can either be ACTIVE or INACTIVE only.
    Type string
    Type of the Log Stream.
    Id string
    ID of the log stream.
    Name string
    Name of the log stream.
    Settings GetLogStreamSettings
    Provider specific configuration.
    Status string
    Log Stream Status - can either be ACTIVE or INACTIVE only.
    Type string
    Type of the Log Stream.
    Id string
    ID of the log stream.
    Name string
    Name of the log stream.
    Settings GetLogStreamSettings
    Provider specific configuration.
    status String
    Log Stream Status - can either be ACTIVE or INACTIVE only.
    type String
    Type of the Log Stream.
    id String
    ID of the log stream.
    name String
    Name of the log stream.
    settings GetLogStreamSettings
    Provider specific configuration.
    status string
    Log Stream Status - can either be ACTIVE or INACTIVE only.
    type string
    Type of the Log Stream.
    id string
    ID of the log stream.
    name string
    Name of the log stream.
    settings GetLogStreamSettings
    Provider specific configuration.
    status str
    Log Stream Status - can either be ACTIVE or INACTIVE only.
    type str
    Type of the Log Stream.
    id str
    ID of the log stream.
    name str
    Name of the log stream.
    settings index.GetLogStreamSettings
    Provider specific configuration.
    status String
    Log Stream Status - can either be ACTIVE or INACTIVE only.
    type String
    Type of the Log Stream.
    id String
    ID of the log stream.
    name String
    Name of the log stream.
    settings Property Map
    Provider specific configuration.

    Supporting Types

    GetLogStreamSettings

    AccountId string
    AWS account ID. Required only for 'aws_eventbridge' type
    Edition string
    Edition of the Splunk Cloud instance. Could be one of: 'aws', 'aws_govcloud', 'gcp'. Required only for 'splunk_cloud_logstreaming' type
    EventSourceName string
    An alphanumeric name (no spaces) to identify this event source in AWS EventBridge. Required only for 'aws_eventbridge' type
    Host string
    The domain name for Splunk Cloud instance. Don't include http or https in the string. For example: 'acme.splunkcloud.com'. Required only for 'splunk_cloud_logstreaming' type
    Region string
    The destination AWS region where event source is located. Required only for 'aws_eventbridge' type
    Token string
    The HEC token for your Splunk Cloud HTTP Event Collector. Required only for 'splunk_cloud_logstreaming' type
    AccountId string
    AWS account ID. Required only for 'aws_eventbridge' type
    Edition string
    Edition of the Splunk Cloud instance. Could be one of: 'aws', 'aws_govcloud', 'gcp'. Required only for 'splunk_cloud_logstreaming' type
    EventSourceName string
    An alphanumeric name (no spaces) to identify this event source in AWS EventBridge. Required only for 'aws_eventbridge' type
    Host string
    The domain name for Splunk Cloud instance. Don't include http or https in the string. For example: 'acme.splunkcloud.com'. Required only for 'splunk_cloud_logstreaming' type
    Region string
    The destination AWS region where event source is located. Required only for 'aws_eventbridge' type
    Token string
    The HEC token for your Splunk Cloud HTTP Event Collector. Required only for 'splunk_cloud_logstreaming' type
    accountId String
    AWS account ID. Required only for 'aws_eventbridge' type
    edition String
    Edition of the Splunk Cloud instance. Could be one of: 'aws', 'aws_govcloud', 'gcp'. Required only for 'splunk_cloud_logstreaming' type
    eventSourceName String
    An alphanumeric name (no spaces) to identify this event source in AWS EventBridge. Required only for 'aws_eventbridge' type
    host String
    The domain name for Splunk Cloud instance. Don't include http or https in the string. For example: 'acme.splunkcloud.com'. Required only for 'splunk_cloud_logstreaming' type
    region String
    The destination AWS region where event source is located. Required only for 'aws_eventbridge' type
    token String
    The HEC token for your Splunk Cloud HTTP Event Collector. Required only for 'splunk_cloud_logstreaming' type
    accountId string
    AWS account ID. Required only for 'aws_eventbridge' type
    edition string
    Edition of the Splunk Cloud instance. Could be one of: 'aws', 'aws_govcloud', 'gcp'. Required only for 'splunk_cloud_logstreaming' type
    eventSourceName string
    An alphanumeric name (no spaces) to identify this event source in AWS EventBridge. Required only for 'aws_eventbridge' type
    host string
    The domain name for Splunk Cloud instance. Don't include http or https in the string. For example: 'acme.splunkcloud.com'. Required only for 'splunk_cloud_logstreaming' type
    region string
    The destination AWS region where event source is located. Required only for 'aws_eventbridge' type
    token string
    The HEC token for your Splunk Cloud HTTP Event Collector. Required only for 'splunk_cloud_logstreaming' type
    account_id str
    AWS account ID. Required only for 'aws_eventbridge' type
    edition str
    Edition of the Splunk Cloud instance. Could be one of: 'aws', 'aws_govcloud', 'gcp'. Required only for 'splunk_cloud_logstreaming' type
    event_source_name str
    An alphanumeric name (no spaces) to identify this event source in AWS EventBridge. Required only for 'aws_eventbridge' type
    host str
    The domain name for Splunk Cloud instance. Don't include http or https in the string. For example: 'acme.splunkcloud.com'. Required only for 'splunk_cloud_logstreaming' type
    region str
    The destination AWS region where event source is located. Required only for 'aws_eventbridge' type
    token str
    The HEC token for your Splunk Cloud HTTP Event Collector. Required only for 'splunk_cloud_logstreaming' type
    accountId String
    AWS account ID. Required only for 'aws_eventbridge' type
    edition String
    Edition of the Splunk Cloud instance. Could be one of: 'aws', 'aws_govcloud', 'gcp'. Required only for 'splunk_cloud_logstreaming' type
    eventSourceName String
    An alphanumeric name (no spaces) to identify this event source in AWS EventBridge. Required only for 'aws_eventbridge' type
    host String
    The domain name for Splunk Cloud instance. Don't include http or https in the string. For example: 'acme.splunkcloud.com'. Required only for 'splunk_cloud_logstreaming' type
    region String
    The destination AWS region where event source is located. Required only for 'aws_eventbridge' type
    token String
    The HEC token for your Splunk Cloud HTTP Event Collector. Required only for 'splunk_cloud_logstreaming' type

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi