log_streams

Creates, updates, deletes, gets or lists a log_streams resource.

Overview

Name	log_streams
Type	Resource
Id	okta.logstreams.log_streams

Fields

The following fields are returned by SELECT queries:

list_log_streams

Name	Datatype	Description
id	string	Unique identifier for the log stream (example: 0oa1orzg0CHSgPcjZ0g4)
name	string	Unique name for the log stream object (example: My AWS EventBridge log stream)
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
created	string (date-time)	Timestamp when the log stream object was created (example: 2022-10-21T16:59:59.000Z)
lastUpdated	string (date-time)	Timestamp when the log stream object was last updated (example: 2022-10-21T17:15:10.000Z)
status	string	Lifecycle status of the log stream object
type	string	Specifies the streaming provider used Supported providers: * aws_eventbridge (AWS EventBridge) * splunk_cloud_logstreaming (Splunk Cloud) Select the provider type to see provider-specific configurations in the settings property:

get_log_stream

Name	Datatype	Description
id	string	Unique identifier for the log stream (example: 0oa1orzg0CHSgPcjZ0g4)
name	string	Unique name for the log stream object (example: My AWS EventBridge log stream)
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
created	string (date-time)	Timestamp when the log stream object was created (example: 2022-10-21T16:59:59.000Z)
lastUpdated	string (date-time)	Timestamp when the log stream object was last updated (example: 2022-10-21T17:15:10.000Z)
status	string	Lifecycle status of the log stream object
type	string	Specifies the streaming provider used Supported providers: * aws_eventbridge (AWS EventBridge) * splunk_cloud_logstreaming (Splunk Cloud) Select the provider type to see provider-specific configurations in the settings property:

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_log_streams	select	subdomain	after, limit, filter	Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression.
get_log_stream	select	subdomain		Retrieves a log stream object by ID
create_log_stream	insert	subdomain, data__created, data__id, data__lastUpdated, data__name, data__status, data__type, data___links		Creates a new log stream object
replace_log_stream	replace	subdomain, data__name, data__type		Replaces the log stream object properties for a given ID. This operation is typically used to update the configuration of a log stream. Depending on the type of log stream you want to update, certain properties can't be modified after the log stream is initially created. Use the Retrieve the log stream schema for the schema type request to determine which properties you can update for the specific log stream type. Log stream properties with the "writeOnce" : true attribute can't be updated after creation. You must still specify these writeOnce properties in the request body with the original values in the PUT request. > Note: You don't have to specify properties that have both the "writeOnce": true and the "writeOnly": true attributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.
delete_log_stream	delete	subdomain		Deletes a log stream object from your org by ID
activate_log_stream	exec	subdomain		Activates a log stream by logStreamId
deactivate_log_stream	exec	subdomain		Deactivates a log stream by logStreamId

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)
after	string	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.
filter	string	An expression that [filters]https://developer.okta.com/docs/api#filter the returned objects. You can only use the eq operator on either the status or type properties in the filter expression.
limit	integer	A limit on the number of objects to return

SELECT examples

list_log_streams

Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression.

SELECT
id,
name,
_links,
created,
lastUpdated,
status,
type
FROM okta.logstreams.log_streams
WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND filter = '{{ filter }}';

get_log_stream

Retrieves a log stream object by ID

SELECT
id,
name,
_links,
created,
lastUpdated,
status,
type
FROM okta.logstreams.log_streams
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_log_stream

Creates a new log stream object

INSERT INTO okta.logstreams.log_streams (
data__name,
data__type,
subdomain
)
SELECT 
'{{ name }}' --required,
'{{ type }}' --required,
'{{ subdomain }}'
RETURNING
id,
name,
_links,
created,
lastUpdated,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: log_streams
  props:
    - name: subdomain
      value: string
      description: Required parameter for the log_streams resource.
    - name: name
      value: string
      description: >
        Unique name for the log stream object
        
    - name: type
      value: string
      description: >
        Specifies the streaming provider used

Supported providers:
  * `aws_eventbridge` ([AWS EventBridge](https://aws.amazon.com/eventbridge))
  * `splunk_cloud_logstreaming` ([Splunk Cloud](https://www.splunk.com/en_us/software/splunk-cloud-platform.html))

Select the provider type to see provider-specific configurations in the `settings` property:
        
      valid_values: ['aws_eventbridge', 'splunk_cloud_logstreaming']

REPLACE examples

replace_log_stream

Replaces the log stream object properties for a given ID.

This operation is typically used to update the configuration of a log stream.
Depending on the type of log stream you want to update, certain properties can't be modified after the log stream is initially created.
Use the Retrieve the log stream schema for the schema type request to determine which properties you can update for the specific log stream type.
Log stream properties with the "writeOnce" : true attribute can't be updated after creation.
You must still specify these writeOnce properties in the request body with the original values in the PUT request.

> Note: You don't have to specify properties that have both the "writeOnce": true and the "writeOnly": true attributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.

REPLACE okta.logstreams.log_streams
SET 
data__name = '{{ name }}',
data__type = '{{ type }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__name = '{{ name }}' --required
AND data__type = '{{ type }}' --required
RETURNING
id,
name,
_links,
created,
lastUpdated,
status,
type;

DELETE examples

delete_log_stream

Deletes a log stream object from your org by ID

DELETE FROM okta.logstreams.log_streams
WHERE subdomain = '{{ subdomain }}' --required;

Lifecycle Methods

activate_log_stream

Activates a log stream by logStreamId

EXEC okta.logstreams.log_streams.activate_log_stream 
@subdomain='{{ subdomain }}' --required;

deactivate_log_stream

Deactivates a log stream by logStreamId

EXEC okta.logstreams.log_streams.deactivate_log_stream 
@subdomain='{{ subdomain }}' --required;