1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Sch
  5. getServiceConnectors
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Sch.getServiceConnectors

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

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

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testServiceConnectors = oci.Sch.getServiceConnectors({
    compartmentId: compartmentId,
    displayName: serviceConnectorDisplayName,
    state: serviceConnectorState,
});
Copy
import pulumi
import pulumi_oci as oci

test_service_connectors = oci.Sch.get_service_connectors(compartment_id=compartment_id,
    display_name=service_connector_display_name,
    state=service_connector_state)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/sch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sch.GetServiceConnectors(ctx, &sch.GetServiceConnectorsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(serviceConnectorDisplayName),
			State:         pulumi.StringRef(serviceConnectorState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testServiceConnectors = Oci.Sch.GetServiceConnectors.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = serviceConnectorDisplayName,
        State = serviceConnectorState,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Sch.SchFunctions;
import com.pulumi.oci.Sch.inputs.GetServiceConnectorsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testServiceConnectors = SchFunctions.getServiceConnectors(GetServiceConnectorsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(serviceConnectorDisplayName)
            .state(serviceConnectorState)
            .build());

    }
}
Copy
variables:
  testServiceConnectors:
    fn::invoke:
      function: oci:Sch:getServiceConnectors
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${serviceConnectorDisplayName}
        state: ${serviceConnectorState}
Copy

Using getServiceConnectors

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getServiceConnectors(args: GetServiceConnectorsArgs, opts?: InvokeOptions): Promise<GetServiceConnectorsResult>
function getServiceConnectorsOutput(args: GetServiceConnectorsOutputArgs, opts?: InvokeOptions): Output<GetServiceConnectorsResult>
Copy
def get_service_connectors(compartment_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[_sch.GetServiceConnectorsFilter]] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetServiceConnectorsResult
def get_service_connectors_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_sch.GetServiceConnectorsFilterArgs]]]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetServiceConnectorsResult]
Copy
func GetServiceConnectors(ctx *Context, args *GetServiceConnectorsArgs, opts ...InvokeOption) (*GetServiceConnectorsResult, error)
func GetServiceConnectorsOutput(ctx *Context, args *GetServiceConnectorsOutputArgs, opts ...InvokeOption) GetServiceConnectorsResultOutput
Copy

> Note: This function is named GetServiceConnectors in the Go SDK.

public static class GetServiceConnectors 
{
    public static Task<GetServiceConnectorsResult> InvokeAsync(GetServiceConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceConnectorsResult> Invoke(GetServiceConnectorsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceConnectorsResult> getServiceConnectors(GetServiceConnectorsArgs args, InvokeOptions options)
public static Output<GetServiceConnectorsResult> getServiceConnectors(GetServiceConnectorsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Sch/getServiceConnectors:getServiceConnectors
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment for this request.
DisplayName string
A filter to return only resources that match the given display name exactly. Example: example_service_connector
Filters Changes to this property will trigger replacement. List<GetServiceConnectorsFilter>
State string
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
CompartmentId This property is required. string
The OCID of the compartment for this request.
DisplayName string
A filter to return only resources that match the given display name exactly. Example: example_service_connector
Filters Changes to this property will trigger replacement. []GetServiceConnectorsFilter
State string
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
compartmentId This property is required. String
The OCID of the compartment for this request.
displayName String
A filter to return only resources that match the given display name exactly. Example: example_service_connector
filters Changes to this property will trigger replacement. List<GetServiceConnectorsFilter>
state String
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
compartmentId This property is required. string
The OCID of the compartment for this request.
displayName string
A filter to return only resources that match the given display name exactly. Example: example_service_connector
filters Changes to this property will trigger replacement. GetServiceConnectorsFilter[]
state string
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
compartment_id This property is required. str
The OCID of the compartment for this request.
display_name str
A filter to return only resources that match the given display name exactly. Example: example_service_connector
filters Changes to this property will trigger replacement. Sequence[sch.GetServiceConnectorsFilter]
state str
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
compartmentId This property is required. String
The OCID of the compartment for this request.
displayName String
A filter to return only resources that match the given display name exactly. Example: example_service_connector
filters Changes to this property will trigger replacement. List<Property Map>
state String
A filter to return only resources that match the given lifecycle state. Example: ACTIVE

getServiceConnectors Result

The following output properties are available:

CompartmentId string
The OCID of the compartment containing the metric.
Id string
The provider-assigned unique ID for this managed resource.
ServiceConnectorCollections List<GetServiceConnectorsServiceConnectorCollection>
The list of service_connector_collection.
DisplayName string
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Filters List<GetServiceConnectorsFilter>
State string
The current state of the connector.
CompartmentId string
The OCID of the compartment containing the metric.
Id string
The provider-assigned unique ID for this managed resource.
ServiceConnectorCollections []GetServiceConnectorsServiceConnectorCollection
The list of service_connector_collection.
DisplayName string
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Filters []GetServiceConnectorsFilter
State string
The current state of the connector.
compartmentId String
The OCID of the compartment containing the metric.
id String
The provider-assigned unique ID for this managed resource.
serviceConnectorCollections List<GetServiceConnectorsServiceConnectorCollection>
The list of service_connector_collection.
displayName String
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
filters List<GetServiceConnectorsFilter>
state String
The current state of the connector.
compartmentId string
The OCID of the compartment containing the metric.
id string
The provider-assigned unique ID for this managed resource.
serviceConnectorCollections GetServiceConnectorsServiceConnectorCollection[]
The list of service_connector_collection.
displayName string
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
filters GetServiceConnectorsFilter[]
state string
The current state of the connector.
compartment_id str
The OCID of the compartment containing the metric.
id str
The provider-assigned unique ID for this managed resource.
service_connector_collections Sequence[sch.GetServiceConnectorsServiceConnectorCollection]
The list of service_connector_collection.
display_name str
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
filters Sequence[sch.GetServiceConnectorsFilter]
state str
The current state of the connector.
compartmentId String
The OCID of the compartment containing the metric.
id String
The provider-assigned unique ID for this managed resource.
serviceConnectorCollections List<Property Map>
The list of service_connector_collection.
displayName String
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
filters List<Property Map>
state String
The current state of the connector.

Supporting Types

GetServiceConnectorsFilter

Name This property is required. string
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
Values This property is required. List<string>
Regex bool
Name This property is required. string
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
Values This property is required. []string
Regex bool
name This property is required. String
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
values This property is required. List<String>
regex Boolean
name This property is required. string
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
values This property is required. string[]
regex boolean
name This property is required. str
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
values This property is required. Sequence[str]
regex bool
name This property is required. String
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
values This property is required. List<String>
regex Boolean

GetServiceConnectorsServiceConnectorCollection

items This property is required. List<Property Map>

GetServiceConnectorsServiceConnectorCollectionItem

CompartmentId This property is required. string
The OCID of the compartment for this request.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
The description of the resource. Avoid entering confidential information.
DisplayName This property is required. string
A filter to return only resources that match the given display name exactly. Example: example_service_connector
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the connector.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
LifecyleDetails This property is required. string
Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
Sources This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSource>
State This property is required. string
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
SystemTags This property is required. Dictionary<string, string>
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}}
Targets This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTarget>
Tasks This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTask>
The list of tasks.
TimeCreated This property is required. string
The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
TimeUpdated This property is required. string
The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
CompartmentId This property is required. string
The OCID of the compartment for this request.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
The description of the resource. Avoid entering confidential information.
DisplayName This property is required. string
A filter to return only resources that match the given display name exactly. Example: example_service_connector
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the connector.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
LifecyleDetails This property is required. string
Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
Sources This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSource
State This property is required. string
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
SystemTags This property is required. map[string]string
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}}
Targets This property is required. []GetServiceConnectorsServiceConnectorCollectionItemTarget
Tasks This property is required. []GetServiceConnectorsServiceConnectorCollectionItemTask
The list of tasks.
TimeCreated This property is required. string
The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
TimeUpdated This property is required. string
The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
compartmentId This property is required. String
The OCID of the compartment for this request.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
The description of the resource. Avoid entering confidential information.
displayName This property is required. String
A filter to return only resources that match the given display name exactly. Example: example_service_connector
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the connector.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
lifecyleDetails This property is required. String
Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
sources This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSource>
state This property is required. String
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
systemTags This property is required. Map<String,String>
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}}
targets This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTarget>
tasks This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTask>
The list of tasks.
timeCreated This property is required. String
The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
timeUpdated This property is required. String
The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
compartmentId This property is required. string
The OCID of the compartment for this request.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
The description of the resource. Avoid entering confidential information.
displayName This property is required. string
A filter to return only resources that match the given display name exactly. Example: example_service_connector
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. string
The OCID of the connector.
lifecycleDetails This property is required. string
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
lifecyleDetails This property is required. string
Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
sources This property is required. GetServiceConnectorsServiceConnectorCollectionItemSource[]
state This property is required. string
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
systemTags This property is required. {[key: string]: string}
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}}
targets This property is required. GetServiceConnectorsServiceConnectorCollectionItemTarget[]
tasks This property is required. GetServiceConnectorsServiceConnectorCollectionItemTask[]
The list of tasks.
timeCreated This property is required. string
The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
timeUpdated This property is required. string
The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
compartment_id This property is required. str
The OCID of the compartment for this request.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
The description of the resource. Avoid entering confidential information.
display_name This property is required. str
A filter to return only resources that match the given display name exactly. Example: example_service_connector
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. str
The OCID of the connector.
lifecycle_details This property is required. str
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
lifecyle_details This property is required. str
Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
sources This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSource]
state This property is required. str
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
system_tags This property is required. Mapping[str, str]
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}}
targets This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemTarget]
tasks This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemTask]
The list of tasks.
time_created This property is required. str
The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
time_updated This property is required. str
The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
compartmentId This property is required. String
The OCID of the compartment for this request.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
The description of the resource. Avoid entering confidential information.
displayName This property is required. String
A filter to return only resources that match the given display name exactly. Example: example_service_connector
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the connector.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
lifecyleDetails This property is required. String
Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state.
sources This property is required. List<Property Map>
state This property is required. String
A filter to return only resources that match the given lifecycle state. Example: ACTIVE
systemTags This property is required. Map<String>
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}}
targets This property is required. List<Property Map>
tasks This property is required. List<Property Map>
The list of tasks.
timeCreated This property is required. String
The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
timeUpdated This property is required. String
The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

GetServiceConnectorsServiceConnectorCollectionItemSource

ConfigMap This property is required. string
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 and review its schema value.
Cursors This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceCursor>
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 This property is required. string
The type of dimension value: static or evaluated.
LogSources This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource>
The logs for this Logging source.
MonitoringSources This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource>
One or more compartment-specific lists of metric namespaces to retrieve data from.
PluginName This property is required. string
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.
PrivateEndpointMetadatas This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata>
The private endpoint metadata for the connector's source or target.
StreamId This property is required. string
The OCID of the stream.
ConfigMap This property is required. string
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 and review its schema value.
Cursors This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourceCursor
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 This property is required. string
The type of dimension value: static or evaluated.
LogSources This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource
The logs for this Logging source.
MonitoringSources This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource
One or more compartment-specific lists of metric namespaces to retrieve data from.
PluginName This property is required. string
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.
PrivateEndpointMetadatas This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata
The private endpoint metadata for the connector's source or target.
StreamId This property is required. string
The OCID of the stream.
configMap This property is required. String
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 and review its schema value.
cursors This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceCursor>
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 This property is required. String
The type of dimension value: static or evaluated.
logSources This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource>
The logs for this Logging source.
monitoringSources This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource>
One or more compartment-specific lists of metric namespaces to retrieve data from.
pluginName This property is required. String
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.
privateEndpointMetadatas This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata>
The private endpoint metadata for the connector's source or target.
streamId This property is required. String
The OCID of the stream.
configMap This property is required. string
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 and review its schema value.
cursors This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourceCursor[]
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 This property is required. string
The type of dimension value: static or evaluated.
logSources This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource[]
The logs for this Logging source.
monitoringSources This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource[]
One or more compartment-specific lists of metric namespaces to retrieve data from.
pluginName This property is required. string
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.
privateEndpointMetadatas This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata[]
The private endpoint metadata for the connector's source or target.
streamId This property is required. string
The OCID of the stream.
config_map This property is required. str
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 and review its schema value.
cursors This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourceCursor]
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 This property is required. str
The type of dimension value: static or evaluated.
log_sources This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource]
The logs for this Logging source.
monitoring_sources This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource]
One or more compartment-specific lists of metric namespaces to retrieve data from.
plugin_name This property is required. str
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.
private_endpoint_metadatas This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata]
The private endpoint metadata for the connector's source or target.
stream_id This property is required. str
The OCID of the stream.
configMap This property is required. String
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 and review its schema value.
cursors This property is required. List<Property Map>
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 This property is required. String
The type of dimension value: static or evaluated.
logSources This property is required. List<Property Map>
The logs for this Logging source.
monitoringSources This property is required. List<Property Map>
One or more compartment-specific lists of metric namespaces to retrieve data from.
pluginName This property is required. String
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.
privateEndpointMetadatas This property is required. List<Property Map>
The private endpoint metadata for the connector's source or target.
streamId This property is required. String
The OCID of the stream.

GetServiceConnectorsServiceConnectorCollectionItemSourceCursor

Kind This property is required. string
The type of dimension value: static or evaluated.
Kind This property is required. string
The type of dimension value: static or evaluated.
kind This property is required. String
The type of dimension value: static or evaluated.
kind This property is required. string
The type of dimension value: static or evaluated.
kind This property is required. str
The type of dimension value: static or evaluated.
kind This property is required. String
The type of dimension value: static or evaluated.

GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource

CompartmentId This property is required. string
The OCID of the compartment for this request.
LogGroupId This property is required. string
The OCID of the Logging Analytics log group.
LogId This property is required. string
The OCID of the log.
CompartmentId This property is required. string
The OCID of the compartment for this request.
LogGroupId This property is required. string
The OCID of the Logging Analytics log group.
LogId This property is required. string
The OCID of the log.
compartmentId This property is required. String
The OCID of the compartment for this request.
logGroupId This property is required. String
The OCID of the Logging Analytics log group.
logId This property is required. String
The OCID of the log.
compartmentId This property is required. string
The OCID of the compartment for this request.
logGroupId This property is required. string
The OCID of the Logging Analytics log group.
logId This property is required. string
The OCID of the log.
compartment_id This property is required. str
The OCID of the compartment for this request.
log_group_id This property is required. str
The OCID of the Logging Analytics log group.
log_id This property is required. str
The OCID of the log.
compartmentId This property is required. String
The OCID of the compartment for this request.
logGroupId This property is required. String
The OCID of the Logging Analytics log group.
logId This property is required. String
The OCID of the log.

GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource

CompartmentId This property is required. string
The OCID of the compartment for this request.
NamespaceDetails This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail>
Discriminator for namespaces in the compartment-specific list.
CompartmentId This property is required. string
The OCID of the compartment for this request.
NamespaceDetails This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail
Discriminator for namespaces in the compartment-specific list.
compartmentId This property is required. String
The OCID of the compartment for this request.
namespaceDetails This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail>
Discriminator for namespaces in the compartment-specific list.
compartmentId This property is required. string
The OCID of the compartment for this request.
namespaceDetails This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail[]
Discriminator for namespaces in the compartment-specific list.
compartment_id This property is required. str
The OCID of the compartment for this request.
namespace_details This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail]
Discriminator for namespaces in the compartment-specific list.
compartmentId This property is required. String
The OCID of the compartment for this request.
namespaceDetails This property is required. List<Property Map>
Discriminator for namespaces in the compartment-specific list.

GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail

Kind This property is required. string
The type of dimension value: static or evaluated.
Namespaces This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace>
The namespaces for the compartment-specific list.
Kind This property is required. string
The type of dimension value: static or evaluated.
Namespaces This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace
The namespaces for the compartment-specific list.
kind This property is required. String
The type of dimension value: static or evaluated.
namespaces This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace>
The namespaces for the compartment-specific list.
kind This property is required. string
The type of dimension value: static or evaluated.
namespaces This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace[]
The namespaces for the compartment-specific list.
kind This property is required. str
The type of dimension value: static or evaluated.
namespaces This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace]
The namespaces for the compartment-specific list.
kind This property is required. String
The type of dimension value: static or evaluated.
namespaces This property is required. List<Property Map>
The namespaces for the compartment-specific list.

GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace

Metrics This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric>
The metrics to query for the specified metric namespace.
Namespace This property is required. string
The namespace.
Metrics This property is required. []GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric
The metrics to query for the specified metric namespace.
Namespace This property is required. string
The namespace.
metrics This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric>
The metrics to query for the specified metric namespace.
namespace This property is required. String
The namespace.
metrics This property is required. GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric[]
The metrics to query for the specified metric namespace.
namespace This property is required. string
The namespace.
metrics This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric]
The metrics to query for the specified metric namespace.
namespace This property is required. str
The namespace.
metrics This property is required. List<Property Map>
The metrics to query for the specified metric namespace.
namespace This property is required. String
The namespace.

GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric

Kind This property is required. string
The type of dimension value: static or evaluated.
Kind This property is required. string
The type of dimension value: static or evaluated.
kind This property is required. String
The type of dimension value: static or evaluated.
kind This property is required. string
The type of dimension value: static or evaluated.
kind This property is required. str
The type of dimension value: static or evaluated.
kind This property is required. String
The type of dimension value: static or evaluated.

GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata

RceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
RceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
RceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
RceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rce_dns_proxy_ip_address This property is required. str
The reverse connection endpoint (RCE) IP address for DNS lookups.
rce_traffic_ip_address This property is required. str
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.

GetServiceConnectorsServiceConnectorCollectionItemTarget

BatchRolloverSizeInMbs This property is required. int
The batch rollover size in megabytes.
BatchRolloverTimeInMs This property is required. int
The batch rollover time in milliseconds.
BatchSizeInKbs This property is required. int
Size limit (kilobytes) for batch sent to invoke the function.
BatchSizeInNum This property is required. int
The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum.
BatchTimeInSec This property is required. int
Time limit (seconds) for batch sent to invoke the function.
Bucket This property is required. string
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
CompartmentId This property is required. string
The OCID of the compartment for this request.
Dimensions This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTargetDimension>
List of dimension names and values.
EnableFormattedMessaging This property is required. bool
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
FunctionId This property is required. string
The OCID of the function to be used as a task.
Kind This property is required. string
The type of dimension value: static or evaluated.
LogGroupId This property is required. string
The OCID of the Logging Analytics log group.
LogSourceIdentifier This property is required. string
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 This property is required. string
The name of the metric. Example: CpuUtilization
MetricNamespace This property is required. string
The namespace of the metric. Example: oci_computeagent
Namespace This property is required. string
The namespace.
ObjectNamePrefix This property is required. string
The prefix of the objects. Avoid entering confidential information.
PrivateEndpointMetadatas This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata>
The private endpoint metadata for the connector's source or target.
StreamId This property is required. string
The OCID of the stream.
TopicId This property is required. string
The OCID of the topic.
BatchRolloverSizeInMbs This property is required. int
The batch rollover size in megabytes.
BatchRolloverTimeInMs This property is required. int
The batch rollover time in milliseconds.
BatchSizeInKbs This property is required. int
Size limit (kilobytes) for batch sent to invoke the function.
BatchSizeInNum This property is required. int
The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum.
BatchTimeInSec This property is required. int
Time limit (seconds) for batch sent to invoke the function.
Bucket This property is required. string
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
CompartmentId This property is required. string
The OCID of the compartment for this request.
Dimensions This property is required. []GetServiceConnectorsServiceConnectorCollectionItemTargetDimension
List of dimension names and values.
EnableFormattedMessaging This property is required. bool
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
FunctionId This property is required. string
The OCID of the function to be used as a task.
Kind This property is required. string
The type of dimension value: static or evaluated.
LogGroupId This property is required. string
The OCID of the Logging Analytics log group.
LogSourceIdentifier This property is required. string
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 This property is required. string
The name of the metric. Example: CpuUtilization
MetricNamespace This property is required. string
The namespace of the metric. Example: oci_computeagent
Namespace This property is required. string
The namespace.
ObjectNamePrefix This property is required. string
The prefix of the objects. Avoid entering confidential information.
PrivateEndpointMetadatas This property is required. []GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata
The private endpoint metadata for the connector's source or target.
StreamId This property is required. string
The OCID of the stream.
TopicId This property is required. string
The OCID of the topic.
batchRolloverSizeInMbs This property is required. Integer
The batch rollover size in megabytes.
batchRolloverTimeInMs This property is required. Integer
The batch rollover time in milliseconds.
batchSizeInKbs This property is required. Integer
Size limit (kilobytes) for batch sent to invoke the function.
batchSizeInNum This property is required. Integer
The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum.
batchTimeInSec This property is required. Integer
Time limit (seconds) for batch sent to invoke the function.
bucket This property is required. String
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
compartmentId This property is required. String
The OCID of the compartment for this request.
dimensions This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTargetDimension>
List of dimension names and values.
enableFormattedMessaging This property is required. Boolean
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
functionId This property is required. String
The OCID of the function to be used as a task.
kind This property is required. String
The type of dimension value: static or evaluated.
logGroupId This property is required. String
The OCID of the Logging Analytics log group.
logSourceIdentifier This property is required. String
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 This property is required. String
The name of the metric. Example: CpuUtilization
metricNamespace This property is required. String
The namespace of the metric. Example: oci_computeagent
namespace This property is required. String
The namespace.
objectNamePrefix This property is required. String
The prefix of the objects. Avoid entering confidential information.
privateEndpointMetadatas This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata>
The private endpoint metadata for the connector's source or target.
streamId This property is required. String
The OCID of the stream.
topicId This property is required. String
The OCID of the topic.
batchRolloverSizeInMbs This property is required. number
The batch rollover size in megabytes.
batchRolloverTimeInMs This property is required. number
The batch rollover time in milliseconds.
batchSizeInKbs This property is required. number
Size limit (kilobytes) for batch sent to invoke the function.
batchSizeInNum This property is required. number
The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum.
batchTimeInSec This property is required. number
Time limit (seconds) for batch sent to invoke the function.
bucket This property is required. string
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
compartmentId This property is required. string
The OCID of the compartment for this request.
dimensions This property is required. GetServiceConnectorsServiceConnectorCollectionItemTargetDimension[]
List of dimension names and values.
enableFormattedMessaging This property is required. boolean
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
functionId This property is required. string
The OCID of the function to be used as a task.
kind This property is required. string
The type of dimension value: static or evaluated.
logGroupId This property is required. string
The OCID of the Logging Analytics log group.
logSourceIdentifier This property is required. string
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 This property is required. string
The name of the metric. Example: CpuUtilization
metricNamespace This property is required. string
The namespace of the metric. Example: oci_computeagent
namespace This property is required. string
The namespace.
objectNamePrefix This property is required. string
The prefix of the objects. Avoid entering confidential information.
privateEndpointMetadatas This property is required. GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata[]
The private endpoint metadata for the connector's source or target.
streamId This property is required. string
The OCID of the stream.
topicId This property is required. string
The OCID of the topic.
batch_rollover_size_in_mbs This property is required. int
The batch rollover size in megabytes.
batch_rollover_time_in_ms This property is required. int
The batch rollover time in milliseconds.
batch_size_in_kbs This property is required. int
Size limit (kilobytes) for batch sent to invoke the function.
batch_size_in_num This property is required. int
The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum.
batch_time_in_sec This property is required. int
Time limit (seconds) for batch sent to invoke the function.
bucket This property is required. str
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 This property is required. str
The OCID of the compartment for this request.
dimensions This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemTargetDimension]
List of dimension names and values.
enable_formatted_messaging This property is required. bool
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 This property is required. str
The OCID of the function to be used as a task.
kind This property is required. str
The type of dimension value: static or evaluated.
log_group_id This property is required. str
The OCID of the Logging Analytics log group.
log_source_identifier This property is required. str
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 This property is required. str
The name of the metric. Example: CpuUtilization
metric_namespace This property is required. str
The namespace of the metric. Example: oci_computeagent
namespace This property is required. str
The namespace.
object_name_prefix This property is required. str
The prefix of the objects. Avoid entering confidential information.
private_endpoint_metadatas This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata]
The private endpoint metadata for the connector's source or target.
stream_id This property is required. str
The OCID of the stream.
topic_id This property is required. str
The OCID of the topic.
batchRolloverSizeInMbs This property is required. Number
The batch rollover size in megabytes.
batchRolloverTimeInMs This property is required. Number
The batch rollover time in milliseconds.
batchSizeInKbs This property is required. Number
Size limit (kilobytes) for batch sent to invoke the function.
batchSizeInNum This property is required. Number
The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum.
batchTimeInSec This property is required. Number
Time limit (seconds) for batch sent to invoke the function.
bucket This property is required. String
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
compartmentId This property is required. String
The OCID of the compartment for this request.
dimensions This property is required. List<Property Map>
List of dimension names and values.
enableFormattedMessaging This property is required. Boolean
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
functionId This property is required. String
The OCID of the function to be used as a task.
kind This property is required. String
The type of dimension value: static or evaluated.
logGroupId This property is required. String
The OCID of the Logging Analytics log group.
logSourceIdentifier This property is required. String
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 This property is required. String
The name of the metric. Example: CpuUtilization
metricNamespace This property is required. String
The namespace of the metric. Example: oci_computeagent
namespace This property is required. String
The namespace.
objectNamePrefix This property is required. String
The prefix of the objects. Avoid entering confidential information.
privateEndpointMetadatas This property is required. List<Property Map>
The private endpoint metadata for the connector's source or target.
streamId This property is required. String
The OCID of the stream.
topicId This property is required. String
The OCID of the topic.

GetServiceConnectorsServiceConnectorCollectionItemTargetDimension

DimensionValues This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue>
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).
Name This property is required. string
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
DimensionValues This property is required. []GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue
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).
Name This property is required. string
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
dimensionValues This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue>
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).
name This property is required. String
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
dimensionValues This property is required. GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue[]
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).
name This property is required. string
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
dimension_values This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue]
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).
name This property is required. str
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
dimensionValues This property is required. List<Property Map>
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).
name This property is required. String
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

GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue

Kind This property is required. string
The type of dimension value: static or evaluated.
Path This property is required. string
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 This property is required. string
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.
Kind This property is required. string
The type of dimension value: static or evaluated.
Path This property is required. string
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 This property is required. string
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.
kind This property is required. String
The type of dimension value: static or evaluated.
path This property is required. String
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 This property is required. String
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.
kind This property is required. string
The type of dimension value: static or evaluated.
path This property is required. string
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 This property is required. string
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.
kind This property is required. str
The type of dimension value: static or evaluated.
path This property is required. str
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 This property is required. str
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.
kind This property is required. String
The type of dimension value: static or evaluated.
path This property is required. String
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 This property is required. String
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.

GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata

RceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
RceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
RceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
RceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rce_dns_proxy_ip_address This property is required. str
The reverse connection endpoint (RCE) IP address for DNS lookups.
rce_traffic_ip_address This property is required. str
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.

GetServiceConnectorsServiceConnectorCollectionItemTask

BatchSizeInKbs This property is required. int
Size limit (kilobytes) for batch sent to invoke the function.
BatchTimeInSec This property is required. int
Time limit (seconds) for batch sent to invoke the function.
Condition This property is required. string
A filter or mask to limit the source used in the flow defined by the connector.
FunctionId This property is required. string
The OCID of the function to be used as a task.
Kind This property is required. string
The type of dimension value: static or evaluated.
PrivateEndpointMetadatas This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata>
The private endpoint metadata for the connector's source or target.
BatchSizeInKbs This property is required. int
Size limit (kilobytes) for batch sent to invoke the function.
BatchTimeInSec This property is required. int
Time limit (seconds) for batch sent to invoke the function.
Condition This property is required. string
A filter or mask to limit the source used in the flow defined by the connector.
FunctionId This property is required. string
The OCID of the function to be used as a task.
Kind This property is required. string
The type of dimension value: static or evaluated.
PrivateEndpointMetadatas This property is required. []GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata
The private endpoint metadata for the connector's source or target.
batchSizeInKbs This property is required. Integer
Size limit (kilobytes) for batch sent to invoke the function.
batchTimeInSec This property is required. Integer
Time limit (seconds) for batch sent to invoke the function.
condition This property is required. String
A filter or mask to limit the source used in the flow defined by the connector.
functionId This property is required. String
The OCID of the function to be used as a task.
kind This property is required. String
The type of dimension value: static or evaluated.
privateEndpointMetadatas This property is required. List<GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata>
The private endpoint metadata for the connector's source or target.
batchSizeInKbs This property is required. number
Size limit (kilobytes) for batch sent to invoke the function.
batchTimeInSec This property is required. number
Time limit (seconds) for batch sent to invoke the function.
condition This property is required. string
A filter or mask to limit the source used in the flow defined by the connector.
functionId This property is required. string
The OCID of the function to be used as a task.
kind This property is required. string
The type of dimension value: static or evaluated.
privateEndpointMetadatas This property is required. GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata[]
The private endpoint metadata for the connector's source or target.
batch_size_in_kbs This property is required. int
Size limit (kilobytes) for batch sent to invoke the function.
batch_time_in_sec This property is required. int
Time limit (seconds) for batch sent to invoke the function.
condition This property is required. str
A filter or mask to limit the source used in the flow defined by the connector.
function_id This property is required. str
The OCID of the function to be used as a task.
kind This property is required. str
The type of dimension value: static or evaluated.
private_endpoint_metadatas This property is required. Sequence[sch.GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata]
The private endpoint metadata for the connector's source or target.
batchSizeInKbs This property is required. Number
Size limit (kilobytes) for batch sent to invoke the function.
batchTimeInSec This property is required. Number
Time limit (seconds) for batch sent to invoke the function.
condition This property is required. String
A filter or mask to limit the source used in the flow defined by the connector.
functionId This property is required. String
The OCID of the function to be used as a task.
kind This property is required. String
The type of dimension value: static or evaluated.
privateEndpointMetadatas This property is required. List<Property Map>
The private endpoint metadata for the connector's source or target.

GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata

RceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
RceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
RceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
RceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. string
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rce_dns_proxy_ip_address This property is required. str
The reverse connection endpoint (RCE) IP address for DNS lookups.
rce_traffic_ip_address This property is required. str
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
rceDnsProxyIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for DNS lookups.
rceTrafficIpAddress This property is required. String
The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi