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

okta.Index.LogStream

Explore with Pulumi AI

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

    Creates an Okta Log Stream.

    This resource allows you to create and configure an Okta Log Stream.

    Example Usage

    AWS EventBridge

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.Index.LogStream;
    import com.pulumi.okta.Index.LogStreamArgs;
    import com.pulumi.okta.Index.inputs.LogStreamSettingsArgs;
    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 example = new LogStream("example", LogStreamArgs.builder()        
                .settings(LogStreamSettingsArgs.builder()
                    .account_id("123456789012")
                    .event_source_name("okta_log_stream")
                    .region("us-north-1")
                    .build())
                .status("ACTIVE")
                .type("aws_eventbridge")
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:Index:LogStream
        properties:
          settings:
            account_id: '123456789012'
            event_source_name: okta_log_stream
            region: us-north-1
          status: ACTIVE
          type: aws_eventbridge
    

    Splunk Event Collector

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.index.LogStream("example", {
        settings: {
            edition: "gcp",
            host: "acme.splunkcloud.com",
            token: "YOUR_HEC_TOKEN",
        },
        status: "ACTIVE",
        type: "splunk_cloud_logstreaming",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.index.LogStream("example",
        settings=okta.index.LogStreamSettingsArgs(
            edition="gcp",
            host="acme.splunkcloud.com",
            token="YOUR_HEC_TOKEN",
        ),
        status="ACTIVE",
        type="splunk_cloud_logstreaming")
    
    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.NewLogStream(ctx, "example", &Index.LogStreamArgs{
    			Settings: &index.LogStreamSettingsArgs{
    				Edition: pulumi.String("gcp"),
    				Host:    pulumi.String("acme.splunkcloud.com"),
    				Token:   pulumi.String("YOUR_HEC_TOKEN"),
    			},
    			Status: pulumi.String("ACTIVE"),
    			Type:   pulumi.String("splunk_cloud_logstreaming"),
    		})
    		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 = new Okta.Index.LogStream("example", new()
        {
            Settings = new Okta.Inputs.LogStreamSettingsArgs
            {
                Edition = "gcp",
                Host = "acme.splunkcloud.com",
                Token = "YOUR_HEC_TOKEN",
            },
            Status = "ACTIVE",
            Type = "splunk_cloud_logstreaming",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.Index.LogStream;
    import com.pulumi.okta.Index.LogStreamArgs;
    import com.pulumi.okta.Index.inputs.LogStreamSettingsArgs;
    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 example = new LogStream("example", LogStreamArgs.builder()        
                .settings(LogStreamSettingsArgs.builder()
                    .edition("gcp")
                    .host("acme.splunkcloud.com")
                    .token("YOUR_HEC_TOKEN")
                    .build())
                .status("ACTIVE")
                .type("splunk_cloud_logstreaming")
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:Index:LogStream
        properties:
          settings:
            edition: gcp
            host: acme.splunkcloud.com
            token: YOUR_HEC_TOKEN
          status: ACTIVE
          type: splunk_cloud_logstreaming
    

    Create LogStream Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LogStream(name: string, args: LogStreamArgs, opts?: CustomResourceOptions);
    @overload
    def LogStream(resource_name: str,
                  args: LogStreamArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def LogStream(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  type: Optional[str] = None,
                  name: Optional[str] = None,
                  settings: Optional[_index.LogStreamSettingsArgs] = None,
                  status: Optional[str] = None)
    func NewLogStream(ctx *Context, name string, args LogStreamArgs, opts ...ResourceOption) (*LogStream, error)
    public LogStream(string name, LogStreamArgs args, CustomResourceOptions? opts = null)
    public LogStream(String name, LogStreamArgs args)
    public LogStream(String name, LogStreamArgs args, CustomResourceOptions options)
    
    type: okta:Index:LogStream
    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 LogStreamArgs
    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 LogStreamArgs
    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 LogStreamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var logStreamResource = new Okta.Index.LogStream("logStreamResource", new()
    {
        Type = "string",
        Name = "string",
        Settings = new Okta.Inputs.LogStreamSettingsArgs
        {
            AccountId = "string",
            Edition = "string",
            EventSourceName = "string",
            Host = "string",
            Region = "string",
            Token = "string",
        },
        Status = "string",
    });
    
    example, err := Index.NewLogStream(ctx, "logStreamResource", &Index.LogStreamArgs{
    	Type: pulumi.String("string"),
    	Name: pulumi.String("string"),
    	Settings: &index.LogStreamSettingsArgs{
    		AccountId:       pulumi.String("string"),
    		Edition:         pulumi.String("string"),
    		EventSourceName: pulumi.String("string"),
    		Host:            pulumi.String("string"),
    		Region:          pulumi.String("string"),
    		Token:           pulumi.String("string"),
    	},
    	Status: pulumi.String("string"),
    })
    
    var logStreamResource = new LogStream("logStreamResource", LogStreamArgs.builder()        
        .type("string")
        .name("string")
        .settings(LogStreamSettingsArgs.builder()
            .accountId("string")
            .edition("string")
            .eventSourceName("string")
            .host("string")
            .region("string")
            .token("string")
            .build())
        .status("string")
        .build());
    
    log_stream_resource = okta.index.LogStream("logStreamResource",
        type="string",
        name="string",
        settings=okta.index.LogStreamSettingsArgs(
            account_id="string",
            edition="string",
            event_source_name="string",
            host="string",
            region="string",
            token="string",
        ),
        status="string")
    
    const logStreamResource = new okta.index.LogStream("logStreamResource", {
        type: "string",
        name: "string",
        settings: {
            accountId: "string",
            edition: "string",
            eventSourceName: "string",
            host: "string",
            region: "string",
            token: "string",
        },
        status: "string",
    });
    
    type: okta:Index:LogStream
    properties:
        name: string
        settings:
            accountId: string
            edition: string
            eventSourceName: string
            host: string
            region: string
            token: string
        status: string
        type: string
    

    LogStream 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 LogStream resource accepts the following input properties:

    Type string
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    Name string
    Name of the Log Stream Resource.
    Settings LogStreamSettings
    Stream provider specific configuration.
    Status string
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    Type string
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    Name string
    Name of the Log Stream Resource.
    Settings LogStreamSettingsArgs
    Stream provider specific configuration.
    Status string
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type String
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name String
    Name of the Log Stream Resource.
    settings LogStreamSettings
    Stream provider specific configuration.
    status String
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type string
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name string
    Name of the Log Stream Resource.
    settings LogStreamSettings
    Stream provider specific configuration.
    status string
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type str
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name str
    Name of the Log Stream Resource.
    settings index.LogStreamSettingsArgs
    Stream provider specific configuration.
    status str
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type String
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name String
    Name of the Log Stream Resource.
    settings Property Map
    Stream provider specific configuration.
    status String
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LogStream resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LogStream Resource

    Get an existing LogStream 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?: LogStreamState, opts?: CustomResourceOptions): LogStream
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            settings: Optional[_index.LogStreamSettingsArgs] = None,
            status: Optional[str] = None,
            type: Optional[str] = None) -> LogStream
    func GetLogStream(ctx *Context, name string, id IDInput, state *LogStreamState, opts ...ResourceOption) (*LogStream, error)
    public static LogStream Get(string name, Input<string> id, LogStreamState? state, CustomResourceOptions? opts = null)
    public static LogStream get(String name, Output<String> id, LogStreamState 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:
    Name string
    Name of the Log Stream Resource.
    Settings LogStreamSettings
    Stream provider specific configuration.
    Status string
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    Type string
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    Name string
    Name of the Log Stream Resource.
    Settings LogStreamSettingsArgs
    Stream provider specific configuration.
    Status string
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    Type string
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name String
    Name of the Log Stream Resource.
    settings LogStreamSettings
    Stream provider specific configuration.
    status String
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type String
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name string
    Name of the Log Stream Resource.
    settings LogStreamSettings
    Stream provider specific configuration.
    status string
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type string
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name str
    Name of the Log Stream Resource.
    settings index.LogStreamSettingsArgs
    Stream provider specific configuration.
    status str
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type str
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.
    name String
    Name of the Log Stream Resource.
    settings Property Map
    Stream provider specific configuration.
    status String
    Log Stream Status - can either be ACTIVE or INACTIVE only. Default is ACTIVE.
    type String
    Type of the Log Stream - can either be "aws_eventbridge" or "splunk_cloud_logstreaming" only.

    Supporting Types

    LogStreamSettings, LogStreamSettingsArgs

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

    Import

    Okta Log Stream can be imported via the Okta ID.

    $ pulumi import okta:Index/logStream:LogStream example &#60;strema id&#62;
    

    To learn more about importing existing cloud resources, see Importing resources.

    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