create-data-source-logging-query-data-source-details

Description

Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.

Usage

oci cloud-guard data-source create-data-source-logging-query-data-source-details [OPTIONS]

Required Parameters

--compartment-id, -c [text]

Compartment OCID of the data source

--data-source-feed-provider [text]

Type of data source feed provider (LoggingQuery)

Accepted values are:

LOGGINGQUERY, SCHEDULEDQUERY
--display-name [text]

Data source display name

Optional Parameters

--data-source-details-additional-entities-count [integer]

The additional entities count used for data source query

--data-source-details-interval-in-minutes [integer]

Interval in minutes that query is run periodically.

--data-source-details-logging-query-details [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--data-source-details-logging-query-type [text]

Type of logging query for data source (Sighting/Insight)

Accepted values are:

INSIGHT
--data-source-details-operator [text]

Operator used in data source

Accepted values are:

EQUAL, GREATER, GREATERTHANEQUALTO, LESS, LESSTHANEQUALTO
--data-source-details-query [text]

The continuous query expression that is run periodicall

--data-source-details-query-start-time [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--data-source-details-regions [complex type]

List of logging query regions This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--data-source-details-threshold [integer]

The integer value that must be exceeded, fall below or equal to (depending on the operator), for the query result to trigger an event

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--freeform-tags [complex type]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Avoid entering confidential information. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--status [text]

Enablement status of data source.

Accepted values are:

DISABLED, ENABLED
--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/data-source/create-data-source-logging-query-data-source-details.html#cmdoption-compartment-id
    export data_source_feed_provider=<substitute-value-of-data_source_feed_provider> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/data-source/create-data-source-logging-query-data-source-details.html#cmdoption-data-source-feed-provider
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/data-source/create-data-source-logging-query-data-source-details.html#cmdoption-display-name

    oci cloud-guard data-source create-data-source-logging-query-data-source-details --compartment-id $compartment_id --data-source-feed-provider $data_source_feed_provider --display-name $display_name