Okta v4.9.0, Jun 19 24

Okta v4.9.0 published on Wednesday, Jun 19, 2024 by Pulumi

okta.LogStream

Explore with Pulumi AI

Okta v4.9.0 published on Wednesday, Jun 19, 2024 by Pulumi

pulumi/pulumi-okta

Example Usage

AWS EventBridge

resource “okta.LogStream” “example” { name = “EventBridge Log Stream” type = “aws_eventbridge” status = “ACTIVE” settings { account_id = “123456789012” region = “us-north-1” event_source_name = “okta.LogStream” } }

Splunk Event Collector

resource “okta.LogStream” “example” { name = “Splunk log Stream” type = “splunk_cloud_logstreaming” status = “ACTIVE” settings { host = “acme.splunkcloud.com” edition = “gcp” token = “YOUR_HEC_TOKEN” } }




## Create LogStream Resource {#create}

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see [Resources](/docs/concepts/resources/).

### Constructor syntax
<div>
<pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser>
</div>


<div>
<pulumi-choosable type="language" values="javascript,typescript">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript"><span class="k">new </span><span class="nx">LogStream</span><span class="p">(</span><span class="nx">name</span><span class="p">:</span> <span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">LogStreamArgs</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span><span class="p">);</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="python">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@overload</span>
<span class="k">def </span><span class="nx">LogStream</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span>
              <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">LogStreamArgs</a></span><span class="p">,</span>
              <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">)</span>
<span></span>
<span class=nd>@overload</span>
<span class="k">def </span><span class="nx">LogStream</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span>
              <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">,</span>
              <span class="nx">type</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
              <span class="nx">name</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
              <span class="nx">settings</span><span class="p">:</span> <span class="nx">Optional[LogStreamSettingsArgs]</span> = None<span class="p">,</span>
              <span class="nx">status</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">)</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="go">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func </span><span class="nx">NewLogStream</span><span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">name</span><span class="p"> </span><span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p"> </span><span class="nx"><a href="#inputs">LogStreamArgs</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span><span class="p">) (*<span class="nx">LogStream</span>, error)</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="csharp">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public </span><span class="nx">LogStream</span><span class="p">(</span><span class="nx">string</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">LogStreamArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="java">
<div class="no-copy"><div class="highlight"><pre class="chroma">
<code class="language-java" data-lang="java"><span class="k">public </span><span class="nx">LogStream</span><span class="p">(</span><span class="nx">String</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">LogStreamArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">)</span>
<span class="k">public </span><span class="nx">LogStream</span><span class="p">(</span><span class="nx">String</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">LogStreamArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">CustomResourceOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span>
</code></pre></div></div>
</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="yaml">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">type: <span class="nx">okta:LogStream</span><span class="p"></span>
<span class="p">properties</span><span class="p">: </span><span class="c">#&nbsp;The arguments to resource properties.</span>
<span class="p"></span><span class="p">options</span><span class="p">: </span><span class="c">#&nbsp;Bag of options to control resource&#39;s behavior.</span>
<span class="p"></span>
</code></pre></div></div>
</pulumi-choosable>
</div>

#### Parameters

<div>
<pulumi-choosable type="language" values="javascript,typescript">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">string</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">LogStreamArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="python">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>resource_name</span>
        <span class="property-indicator"></span>
        <span class="property-type">str</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">LogStreamArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">ResourceOptions</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="go">

<dl class="resources-properties"><dt
        class="property-optional" title="Optional">
        <span>ctx</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span>
    </dt>
    <dd>Context object for the current deployment.</dd><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">string</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">LogStreamArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="csharp">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">string</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">LogStreamArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="java">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">String</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">LogStreamArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>options</span>
        <span class="property-indicator"></span>
        <span class="property-type">CustomResourceOptions</span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>



### Example

The following reference example uses placeholder values for all [input properties](#inputs).
<div>
<pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser>
</div>


<div>
<pulumi-choosable type="language" values="csharp">

```csharp
var logStreamResource = new Okta.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 := okta.NewLogStream(ctx, "logStreamResource", &okta.LogStreamArgs{
	Type: pulumi.String("string"),
	Name: pulumi.String("string"),
	Settings: &okta.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.LogStream("logStreamResource",
    type="string",
    name="string",
    settings=okta.LogStreamSettingsArgs(
        account_id="string",
        edition="string",
        event_source_name="string",
        host="string",
        region="string",
        token="string",
    ),
    status="string")

const logStreamResource = new okta.LogStream("logStreamResource", {
    type: "string",
    name: "string",
    settings: {
        accountId: "string",
        edition: "string",
        eventSourceName: "string",
        host: "string",
        region: "string",
        token: "string",
    },
    status: "string",
});

type: okta: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: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'
Name string: Unique name for the Log Stream object
Settings LogStreamSettings
Status string: Stream status

Type string: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'
Name string: Unique name for the Log Stream object
Settings LogStreamSettingsArgs
Status string: Stream status

type String: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'
name String: Unique name for the Log Stream object
settings LogStreamSettings
status String: Stream status

type string: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'
name string: Unique name for the Log Stream object
settings LogStreamSettings
status string: Stream status

type str: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'
name str: Unique name for the Log Stream object
settings LogStreamSettingsArgs
status str: Stream status

type String: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'
name String: Unique name for the Log Stream object
settings Property Map
status String: Stream status

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[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: Unique name for the Log Stream object
Settings LogStreamSettings
Status string: Stream status
Type string: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'

Name string: Unique name for the Log Stream object
Settings LogStreamSettingsArgs
Status string: Stream status
Type string: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'

name String: Unique name for the Log Stream object
settings LogStreamSettings
status String: Stream status
type String: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'

name string: Unique name for the Log Stream object
settings LogStreamSettings
status string: Stream status
type string: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'

name str: Unique name for the Log Stream object
settings LogStreamSettingsArgs
status str: Stream status
type str: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'

name String: Unique name for the Log Stream object
settings Property Map
status String: Stream status
type String: Streaming provider used - 'awseventbridge' or 'splunkcloud_logstreaming'

Supporting Types

LogStreamSettings, LogStreamSettingsArgs

AccountId string: AWS account ID. Required only for 'aws_eventbridge' type
Edition string: Edition of the Splunk Cloud instance. Could be one of: 'aws', 'awsgovcloud', 'gcp'. Required only for 'splunkcloud_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 'splunkcloudlogstreaming' 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 'splunkcloudlogstreaming' 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', 'awsgovcloud', 'gcp'. Required only for 'splunkcloud_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 'splunkcloudlogstreaming' 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 'splunkcloudlogstreaming' 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', 'awsgovcloud', 'gcp'. Required only for 'splunkcloud_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 'splunkcloudlogstreaming' 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 'splunkcloudlogstreaming' 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', 'awsgovcloud', 'gcp'. Required only for 'splunkcloud_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 'splunkcloudlogstreaming' 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 'splunkcloudlogstreaming' 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', 'awsgovcloud', 'gcp'. Required only for 'splunkcloud_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 'splunkcloudlogstreaming' 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 'splunkcloudlogstreaming' 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', 'awsgovcloud', 'gcp'. Required only for 'splunkcloud_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 'splunkcloudlogstreaming' 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 'splunkcloudlogstreaming' type

Import

$ 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 v4.9.0 published on Wednesday, Jun 19, 2024 by Pulumi

pulumi/pulumi-okta

okta.LogStream

On this page

On this page

Example Usage

AWS EventBridge

Splunk Event Collector

LogStream Resource Properties

Inputs

Outputs

Look up Existing LogStream Resource

Supporting Types

LogStreamSettings, LogStreamSettingsArgs

Import

Package Details

On this page

On this page