Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. LogStream
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.LogStream

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    Manages log streams

    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[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: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.

    Constructor example

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

    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={
        "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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 <stream_id>

    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.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta