Data Source: oci_sch_service_connectors

This data source provides the list of Service Connectors in Oracle Cloud Infrastructure Service Connector Hub service.

Lists connectors in the specified compartment. For more information, see Listing Connectors.

Example Usage

data "oci_sch_service_connectors" "test_service_connectors" {
	#Required
	compartment_id = var.compartment_id

	#Optional
	display_name = var.service_connector_display_name
	state = var.service_connector_state
}

Argument Reference

The following arguments are supported:

• compartment_id - (Required) The OCID of the compartment for this request.
• display_name - (Optional) A filter to return only resources that match the given display name exactly. Example: example_service_connector
• state - (Optional) A filter to return only resources that match the given lifecycle state. Example: ACTIVE

Attributes Reference

The following attributes are exported:

• service_connector_collection - The list of service_connector_collection.

ServiceConnector Reference

The following attributes are exported:

• compartment_id - The OCID of the compartment containing the connector.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
• description - The description of the resource. Avoid entering confidential information.
• display_name - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
• freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
• id - The OCID of the connector.
• lifecyle_details - A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
• source - An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
  • config_map - The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for QueueSource, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using (GetConnectorPlugin)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
  • cursor - The read setting, which determines where in the stream to start moving data. For configuration instructions, see Creating a Connector with a Streaming Source.
    • kind - The type discriminator.
  • kind - The type discriminator.
  • log_sources - The logs for this Logging source.
    • compartment_id - The OCID of the compartment containing the log source.
    • log_group_id - The OCID of the log group. Note: For the Notifications target, only _Audit is allowed. Example OCID for _Audit log group: ocid1.tenancy.oc1..exampleuniqueid/_Audit
    • log_id - The OCID of the log.
  • monitoring_sources - One or more compartment-specific lists of metric namespaces to retrieve data from.
    • compartment_id - The OCID of a compartment containing metric namespaces you want to use for the Monitoring source.
    • namespace_details - Discriminator for namespaces in the compartment-specific list.
      • kind - The type discriminator.
      • namespaces - The namespaces for the compartment-specific list.
        • metrics - The metrics to query for the specified metric namespace.
          • kind - The type discriminator.
        • namespace - The source service or application to use when querying for metric data points. Must begin with oci_. Example: oci_computeagent
  • plugin_name - The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, QueueSource indicates the Queue service. To find names of connector plugins, list the plugin using (ListConnectorPlugin)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
  • stream_id - The OCID of the stream.
• state - The current state of the connector.
• system_tags - The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
• target - An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
  • batch_rollover_size_in_mbs - The batch rollover size in megabytes.
  • batch_rollover_time_in_ms - The batch rollover time in milliseconds.
  • batch_size_in_kbs - The batch rollover size in kilobytes.
  • batch_size_in_num - The batch rollover size in number of messages.
  • batch_time_in_sec - The batch rollover time in seconds.
  • bucket - The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-), underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1
  • compartment_id - The OCID of the compartment containing the metric.
  • dimensions - List of dimension names and values.
    • dimension_value - Instructions for extracting the value corresponding to the specified dimension key: Either extract the value as-is (static) or derive the value from a path (evaluated).
      • kind - The type of dimension value: static or evaluated.
      • path - The location to use for deriving the dimension value (evaluated). The path must start with logContent in an acceptable notation style with supported JMESPath selectors: expression with dot and index operator (. and []). Example with dot notation: logContent.data Example with index notation: logContent.data[0].content For information on valid dimension keys and values, see MetricDataDetails Reference. The returned value depends on the results of evaluation. If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value "compartmentId" is returned as compartmentId.) If the evaluated value is invalid, then the returned value is SCH_EVAL_INVALID_VALUE. If the evaluated value is empty, then the returned value is SCH_EVAL_VALUE_EMPTY.
      • value - The data extracted from the specified dimension value (passed as-is). Unicode characters only. For information on valid dimension keys and values, see MetricDataDetails Reference.
    • name - Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails Reference. Example: type
  • enable_formatted_messaging - Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol. Example: true
  • function_id - The OCID of the function.
  • kind - The type discriminator.
  • log_group_id - The OCID of the Logging Analytics log group.
  • log_source_identifier - Identifier of the log source that you want to use for processing data received from the connector source. Applies to StreamingSource only. Equivalent to name at LogAnalyticsSource.
  • metric - The name of the metric. Example: CpuUtilization
  • metric_namespace - The namespace of the metric. Example: oci_computeagent
  • namespace - The namespace.
  • object_name_prefix - The prefix of the objects. Avoid entering confidential information.
  • stream_id - The OCID of the stream.
  • topic_id - The OCID of the topic.
• tasks - The list of tasks.
  • batch_size_in_kbs - Size limit (kilobytes) for batch sent to invoke the function.
  • batch_time_in_sec - Time limit (seconds) for batch sent to invoke the function.
  • condition - A filter or mask to limit the source used in the flow defined by the connector.
  • function_id - The OCID of the function to be used as a task.
  • kind - The type discriminator.
• time_created - The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
• time_updated - The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z