Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
oci.Sch.getServiceConnectors
Explore with Pulumi AI
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,
});
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)
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
})
}
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,
});
});
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());
}
}
variables:
testServiceConnectors:
fn::invoke:
function: oci:Sch:getServiceConnectors
arguments:
compartmentId: ${compartmentId}
displayName: ${serviceConnectorDisplayName}
state: ${serviceConnectorState}
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>
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]
func GetServiceConnectors(ctx *Context, args *GetServiceConnectorsArgs, opts ...InvokeOption) (*GetServiceConnectorsResult, error)
func GetServiceConnectorsOutput(ctx *Context, args *GetServiceConnectorsOutputArgs, opts ...InvokeOption) GetServiceConnectorsResultOutput
> 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)
}
public static CompletableFuture<GetServiceConnectorsResult> getServiceConnectors(GetServiceConnectorsArgs args, InvokeOptions options)
public static Output<GetServiceConnectorsResult> getServiceConnectors(GetServiceConnectorsArgs args, InvokeOptions options)
fn::invoke:
function: oci:Sch/getServiceConnectors:getServiceConnectors
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Display
Name 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.
Service Connectors Filter> - State string
- A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Display
Name 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.
Service Connectors Filter - State string
- A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- display
Name 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.
Service Connectors Filter> - state String
- A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
- compartment
Id This property is required. string - The OCID of the compartment for this request.
- display
Name 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.
Service Connectors Filter[] - 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.
Get Service Connectors Filter] - state str
- A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- display
Name 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.
- state String
- A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
getServiceConnectors Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment containing the metric.
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Connector List<GetCollections Service Connectors Service Connector Collection> - The list of service_connector_collection.
- Display
Name string - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
- Filters
List<Get
Service Connectors Filter> - State string
- The current state of the connector.
- Compartment
Id string - The OCID of the compartment containing the metric.
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Connector []GetCollections Service Connectors Service Connector Collection - The list of service_connector_collection.
- Display
Name string - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
- Filters
[]Get
Service Connectors Filter - State string
- The current state of the connector.
- compartment
Id String - The OCID of the compartment containing the metric.
- id String
- The provider-assigned unique ID for this managed resource.
- service
Connector List<GetCollections Service Connectors Service Connector Collection> - The list of service_connector_collection.
- display
Name String - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
- filters
List<Get
Service Connectors Filter> - state String
- The current state of the connector.
- compartment
Id string - The OCID of the compartment containing the metric.
- id string
- The provider-assigned unique ID for this managed resource.
- service
Connector GetCollections Service Connectors Service Connector Collection[] - The list of service_connector_collection.
- display
Name string - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
- filters
Get
Service Connectors Filter[] - 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_ Sequence[sch.collections Get Service Connectors Service Connector Collection] - 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.
Get Service Connectors Filter] - state str
- The current state of the connector.
- compartment
Id String - The OCID of the compartment containing the metric.
- id String
- The provider-assigned unique ID for this managed resource.
- service
Connector List<Property Map>Collections - The list of service_connector_collection.
- display
Name 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<GetService Connectors Service Connector Collection Item>
- Items
This property is required. []GetService Connectors Service Connector Collection Item
- items
This property is required. List<GetService Connectors Service Connector Collection Item>
- items
This property is required. GetService Connectors Service Connector Collection Item[]
- items
This property is required. Sequence[sch.Get Service Connectors Service Connector Collection Item]
- items
This property is required. List<Property Map>
GetServiceConnectorsServiceConnectorCollectionItem
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
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.
- Display
Name This property is required. string - A filter to return only resources that match the given display name exactly. Example:
example_service_connector
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.
- Lifecycle
Details 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. - Lifecyle
Details 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 aFAILED
state. - Sources
This property is required. List<GetService Connectors Service Connector Collection Item Source> - State
This property is required. string - A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
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<GetService Connectors Service Connector Collection Item Target> - Tasks
This property is required. List<GetService Connectors Service Connector Collection Item Task> - The list of tasks.
- Time
Created 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
- Time
Updated 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. string - The OCID of the compartment for this request.
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.
- Display
Name This property is required. string - A filter to return only resources that match the given display name exactly. Example:
example_service_connector
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.
- Lifecycle
Details 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. - Lifecyle
Details 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 aFAILED
state. - Sources
This property is required. []GetService Connectors Service Connector Collection Item Source - State
This property is required. string - A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
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. []GetService Connectors Service Connector Collection Item Target - Tasks
This property is required. []GetService Connectors Service Connector Collection Item Task - The list of tasks.
- Time
Created 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
- Time
Updated 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. String - The OCID of the compartment for this request.
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.
- display
Name This property is required. String - A filter to return only resources that match the given display name exactly. Example:
example_service_connector
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.
- lifecycle
Details 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. - lifecyle
Details 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 aFAILED
state. - sources
This property is required. List<GetService Connectors Service Connector Collection Item Source> - state
This property is required. String - A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
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<GetService Connectors Service Connector Collection Item Target> - tasks
This property is required. List<GetService Connectors Service Connector Collection Item Task> - The list of tasks.
- time
Created 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
- time
Updated 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. string - The OCID of the compartment for this request.
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.
- display
Name This property is required. string - A filter to return only resources that match the given display name exactly. Example:
example_service_connector
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.
- lifecycle
Details 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. - lifecyle
Details 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 aFAILED
state. - sources
This property is required. GetService Connectors Service Connector Collection Item Source[] - state
This property is required. string - A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
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. GetService Connectors Service Connector Collection Item Target[] - tasks
This property is required. GetService Connectors Service Connector Collection Item Task[] - The list of tasks.
- time
Created 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
- time
Updated 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.
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
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 aFAILED
state. - sources
This property is required. Sequence[sch.Get Service Connectors Service Connector Collection Item Source] - state
This property is required. str - A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
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.Get Service Connectors Service Connector Collection Item Target] - tasks
This property is required. Sequence[sch.Get Service Connectors Service Connector Collection Item Task] - 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
- compartment
Id This property is required. String - The OCID of the compartment for this request.
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.
- display
Name This property is required. String - A filter to return only resources that match the given display name exactly. Example:
example_service_connector
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.
- lifecycle
Details 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. - lifecyle
Details 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 aFAILED
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
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.
- time
Created 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
- time
Updated 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
- Config
Map 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<GetService Connectors Service Connector Collection Item Source 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
This property is required. string - The type of dimension value: static or evaluated.
- Log
Sources This property is required. List<GetService Connectors Service Connector Collection Item Source Log Source> - The logs for this Logging source.
- Monitoring
Sources This property is required. List<GetService Connectors Service Connector Collection Item Source Monitoring Source> - One or more compartment-specific lists of metric namespaces to retrieve data from.
- Plugin
Name 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. - Private
Endpoint Metadatas This property is required. List<GetService Connectors Service Connector Collection Item Source Private Endpoint Metadata> - The private endpoint metadata for the connector's source or target.
- Stream
Id This property is required. string - The OCID of the stream.
- Config
Map 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. []GetService Connectors Service Connector Collection Item Source 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
This property is required. string - The type of dimension value: static or evaluated.
- Log
Sources This property is required. []GetService Connectors Service Connector Collection Item Source Log Source - The logs for this Logging source.
- Monitoring
Sources This property is required. []GetService Connectors Service Connector Collection Item Source Monitoring Source - One or more compartment-specific lists of metric namespaces to retrieve data from.
- Plugin
Name 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. - Private
Endpoint Metadatas This property is required. []GetService Connectors Service Connector Collection Item Source Private Endpoint Metadata - The private endpoint metadata for the connector's source or target.
- Stream
Id This property is required. string - The OCID of the stream.
- config
Map 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<GetService Connectors Service Connector Collection Item Source 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
This property is required. String - The type of dimension value: static or evaluated.
- log
Sources This property is required. List<GetService Connectors Service Connector Collection Item Source Log Source> - The logs for this Logging source.
- monitoring
Sources This property is required. List<GetService Connectors Service Connector Collection Item Source Monitoring Source> - One or more compartment-specific lists of metric namespaces to retrieve data from.
- plugin
Name 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. - private
Endpoint Metadatas This property is required. List<GetService Connectors Service Connector Collection Item Source Private Endpoint Metadata> - The private endpoint metadata for the connector's source or target.
- stream
Id This property is required. String - The OCID of the stream.
- config
Map 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. GetService Connectors Service Connector Collection Item Source 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
This property is required. string - The type of dimension value: static or evaluated.
- log
Sources This property is required. GetService Connectors Service Connector Collection Item Source Log Source[] - The logs for this Logging source.
- monitoring
Sources This property is required. GetService Connectors Service Connector Collection Item Source Monitoring Source[] - One or more compartment-specific lists of metric namespaces to retrieve data from.
- plugin
Name 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. - private
Endpoint Metadatas This property is required. GetService Connectors Service Connector Collection Item Source Private Endpoint Metadata[] - The private endpoint metadata for the connector's source or target.
- stream
Id 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.Get Service Connectors Service Connector Collection Item Source 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
This property is required. str - The type of dimension value: static or evaluated.
- log_
sources This property is required. Sequence[sch.Get Service Connectors Service Connector Collection Item Source Log Source] - The logs for this Logging source.
- monitoring_
sources This property is required. Sequence[sch.Get Service Connectors Service Connector Collection Item Source Monitoring Source] - 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.Get Service Connectors Service Connector Collection Item Source Private Endpoint Metadata] - The private endpoint metadata for the connector's source or target.
- stream_
id This property is required. str - The OCID of the stream.
- config
Map 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.
- log
Sources This property is required. List<Property Map> - The logs for this Logging source.
- monitoring
Sources This property is required. List<Property Map> - One or more compartment-specific lists of metric namespaces to retrieve data from.
- plugin
Name 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. - private
Endpoint Metadatas This property is required. List<Property Map> - The private endpoint metadata for the connector's source or target.
- stream
Id 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
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Log
Group Id This property is required. string - The OCID of the Logging Analytics log group.
- Log
Id This property is required. string - The OCID of the log.
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Log
Group Id This property is required. string - The OCID of the Logging Analytics log group.
- Log
Id This property is required. string - The OCID of the log.
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- log
Group Id This property is required. String - The OCID of the Logging Analytics log group.
- log
Id This property is required. String - The OCID of the log.
- compartment
Id This property is required. string - The OCID of the compartment for this request.
- log
Group Id This property is required. string - The OCID of the Logging Analytics log group.
- log
Id 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.
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- log
Group Id This property is required. String - The OCID of the Logging Analytics log group.
- log
Id This property is required. String - The OCID of the log.
GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Namespace
Details This property is required. List<GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail> - Discriminator for namespaces in the compartment-specific list.
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Namespace
Details This property is required. []GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail - Discriminator for namespaces in the compartment-specific list.
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- namespace
Details This property is required. List<GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail> - Discriminator for namespaces in the compartment-specific list.
- compartment
Id This property is required. string - The OCID of the compartment for this request.
- namespace
Details This property is required. GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail[] - 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.Get Service Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail] - Discriminator for namespaces in the compartment-specific list.
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- namespace
Details 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<GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace> - 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. []GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace - 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<GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace> - 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. GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace[] - 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.Get Service Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace] - 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<GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace Metric> - The metrics to query for the specified metric namespace.
- Namespace
This property is required. string - The namespace.
- Metrics
This property is required. []GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace Metric - The metrics to query for the specified metric namespace.
- Namespace
This property is required. string - The namespace.
- metrics
This property is required. List<GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace Metric> - The metrics to query for the specified metric namespace.
- namespace
This property is required. String - The namespace.
- metrics
This property is required. GetService Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace Metric[] - The metrics to query for the specified metric namespace.
- namespace
This property is required. string - The namespace.
- metrics
This property is required. Sequence[sch.Get Service Connectors Service Connector Collection Item Source Monitoring Source Namespace Detail Namespace Metric] - 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
- Rce
Dns Proxy Ip Address This property is required. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- Rce
Traffic Ip Address 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. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- Rce
Traffic Ip Address 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. String - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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.
- rce
Dns Proxy Ip Address This property is required. String - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address This property is required. String - The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
GetServiceConnectorsServiceConnectorCollectionItemTarget
- 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
orbatchSizeInNum
. - Batch
Time In Sec 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
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Dimensions
This property is required. List<GetService Connectors Service Connector Collection Item Target Dimension> - 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. 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.
- Log
Group Id This property is required. string - The OCID of the Logging Analytics log group.
- Log
Source Identifier 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 toname
at LogAnalyticsSource. - Metric
This property is required. string - The name of the metric. Example:
CpuUtilization
- Metric
Namespace This property is required. string - The namespace of the metric. Example:
oci_computeagent
- Namespace
This property is required. string - The namespace.
- Object
Name Prefix This property is required. string - The prefix of the objects. Avoid entering confidential information.
- Private
Endpoint Metadatas This property is required. List<GetService Connectors Service Connector Collection Item Target Private Endpoint Metadata> - The private endpoint metadata for the connector's source or target.
- Stream
Id This property is required. string - The OCID of the stream.
- Topic
Id 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
orbatchSizeInNum
. - Batch
Time In Sec 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
- Compartment
Id This property is required. string - The OCID of the compartment for this request.
- Dimensions
This property is required. []GetService Connectors Service Connector Collection Item Target Dimension - 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. 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.
- Log
Group Id This property is required. string - The OCID of the Logging Analytics log group.
- Log
Source Identifier 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 toname
at LogAnalyticsSource. - Metric
This property is required. string - The name of the metric. Example:
CpuUtilization
- Metric
Namespace This property is required. string - The namespace of the metric. Example:
oci_computeagent
- Namespace
This property is required. string - The namespace.
- Object
Name Prefix This property is required. string - The prefix of the objects. Avoid entering confidential information.
- Private
Endpoint Metadatas This property is required. []GetService Connectors Service Connector Collection Item Target Private Endpoint Metadata - The private endpoint metadata for the connector's source or target.
- Stream
Id This property is required. string - The OCID of the stream.
- Topic
Id This property is required. string - The OCID of the topic.
- batch
Rollover Size In Mbs This property is required. Integer - The batch rollover size in megabytes.
- batch
Rollover Time In Ms This property is required. Integer - The batch rollover time in milliseconds.
- batch
Size In Kbs This property is required. Integer - Size limit (kilobytes) for batch sent to invoke the function.
- batch
Size In Num This property is required. Integer - The batch rollover size in number of messages. Only one size option can be specified:
batchSizeInKbs
orbatchSizeInNum
. - batch
Time In Sec 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
- compartment
Id This property is required. String - The OCID of the compartment for this request.
- dimensions
This property is required. List<GetService Connectors Service Connector Collection Item Target Dimension> - List of dimension names and values.
- enable
Formatted Messaging 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
- function
Id 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.
- log
Group Id This property is required. String - The OCID of the Logging Analytics log group.
- log
Source Identifier 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 toname
at LogAnalyticsSource. - metric
This property is required. String - The name of the metric. Example:
CpuUtilization
- metric
Namespace This property is required. String - The namespace of the metric. Example:
oci_computeagent
- namespace
This property is required. String - The namespace.
- object
Name Prefix This property is required. String - The prefix of the objects. Avoid entering confidential information.
- private
Endpoint Metadatas This property is required. List<GetService Connectors Service Connector Collection Item Target Private Endpoint Metadata> - The private endpoint metadata for the connector's source or target.
- stream
Id This property is required. String - The OCID of the stream.
- topic
Id This property is required. String - The OCID of the topic.
- batch
Rollover Size In Mbs This property is required. number - The batch rollover size in megabytes.
- batch
Rollover Time In Ms This property is required. number - The batch rollover time in milliseconds.
- batch
Size In Kbs This property is required. number - Size limit (kilobytes) for batch sent to invoke the function.
- batch
Size In Num This property is required. number - The batch rollover size in number of messages. Only one size option can be specified:
batchSizeInKbs
orbatchSizeInNum
. - batch
Time In Sec 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
- compartment
Id This property is required. string - The OCID of the compartment for this request.
- dimensions
This property is required. GetService Connectors Service Connector Collection Item Target Dimension[] - List of dimension names and values.
- enable
Formatted Messaging 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
- function
Id 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.
- log
Group Id This property is required. string - The OCID of the Logging Analytics log group.
- log
Source Identifier 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 toname
at LogAnalyticsSource. - metric
This property is required. string - The name of the metric. Example:
CpuUtilization
- metric
Namespace This property is required. string - The namespace of the metric. Example:
oci_computeagent
- namespace
This property is required. string - The namespace.
- object
Name Prefix This property is required. string - The prefix of the objects. Avoid entering confidential information.
- private
Endpoint Metadatas This property is required. GetService Connectors Service Connector Collection Item Target Private Endpoint Metadata[] - The private endpoint metadata for the connector's source or target.
- stream
Id This property is required. string - The OCID of the stream.
- topic
Id 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
orbatchSizeInNum
. - 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.Get Service Connectors Service Connector Collection Item Target Dimension] - 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 toname
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.Get Service Connectors Service Connector Collection Item Target Private Endpoint Metadata] - 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.
- batch
Rollover Size In Mbs This property is required. Number - The batch rollover size in megabytes.
- batch
Rollover Time In Ms This property is required. Number - The batch rollover time in milliseconds.
- batch
Size In Kbs This property is required. Number - Size limit (kilobytes) for batch sent to invoke the function.
- batch
Size In Num This property is required. Number - The batch rollover size in number of messages. Only one size option can be specified:
batchSizeInKbs
orbatchSizeInNum
. - batch
Time In Sec 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
- compartment
Id 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.
- enable
Formatted Messaging 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
- function
Id 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.
- log
Group Id This property is required. String - The OCID of the Logging Analytics log group.
- log
Source Identifier 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 toname
at LogAnalyticsSource. - metric
This property is required. String - The name of the metric. Example:
CpuUtilization
- metric
Namespace This property is required. String - The namespace of the metric. Example:
oci_computeagent
- namespace
This property is required. String - The namespace.
- object
Name Prefix This property is required. String - The prefix of the objects. Avoid entering confidential information.
- private
Endpoint Metadatas This property is required. List<Property Map> - The private endpoint metadata for the connector's source or target.
- stream
Id This property is required. String - The OCID of the stream.
- topic
Id This property is required. String - The OCID of the topic.
GetServiceConnectorsServiceConnectorCollectionItemTargetDimension
- Dimension
Values This property is required. List<GetService Connectors Service Connector Collection Item Target Dimension 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).
- 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. []GetService Connectors Service Connector Collection Item Target Dimension 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).
- 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. List<GetService Connectors Service Connector Collection Item Target Dimension 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).
- 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. GetService Connectors Service Connector Collection Item Target Dimension 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).
- 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.Get Service Connectors Service Connector Collection Item Target Dimension 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).
- 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
- dimension
Values 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 ascompartmentId
.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE
. If the evaluated value is empty, then the returned value isSCH_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 ascompartmentId
.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE
. If the evaluated value is empty, then the returned value isSCH_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 ascompartmentId
.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE
. If the evaluated value is empty, then the returned value isSCH_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 ascompartmentId
.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE
. If the evaluated value is empty, then the returned value isSCH_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 ascompartmentId
.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE
. If the evaluated value is empty, then the returned value isSCH_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 ascompartmentId
.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE
. If the evaluated value is empty, then the returned value isSCH_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
- Rce
Dns Proxy Ip Address This property is required. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- Rce
Traffic Ip Address 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. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- Rce
Traffic Ip Address 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. String - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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.
- rce
Dns Proxy Ip Address This property is required. String - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address This property is required. String - The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.
GetServiceConnectorsServiceConnectorCollectionItemTask
- 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. string - A filter or mask to limit the source used in the flow defined by the connector.
- Function
Id 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.
- Private
Endpoint Metadatas This property is required. List<GetService Connectors Service Connector Collection Item Task Private Endpoint Metadata> - 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. string - A filter or mask to limit the source used in the flow defined by the connector.
- Function
Id 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.
- Private
Endpoint Metadatas This property is required. []GetService Connectors Service Connector Collection Item Task Private Endpoint Metadata - The private endpoint metadata for the connector's source or target.
- batch
Size In Kbs This property is required. Integer - Size limit (kilobytes) for batch sent to invoke the function.
- batch
Time In Sec 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.
- function
Id 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.
- private
Endpoint Metadatas This property is required. List<GetService Connectors Service Connector Collection Item Task Private Endpoint Metadata> - The private endpoint metadata for the connector's source or target.
- batch
Size In Kbs This property is required. number - Size limit (kilobytes) for batch sent to invoke the function.
- batch
Time In Sec 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.
- function
Id 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.
- private
Endpoint Metadatas This property is required. GetService Connectors Service Connector Collection Item Task Private Endpoint Metadata[] - 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.Get Service Connectors Service Connector Collection Item Task Private Endpoint Metadata] - The private endpoint metadata for the connector's source or target.
- batch
Size In Kbs This property is required. Number - Size limit (kilobytes) for batch sent to invoke the function.
- batch
Time In Sec 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.
- function
Id 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.
- private
Endpoint Metadatas This property is required. List<Property Map> - The private endpoint metadata for the connector's source or target.
GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata
- Rce
Dns Proxy Ip Address This property is required. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- Rce
Traffic Ip Address 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. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- Rce
Traffic Ip Address 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. String - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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. string - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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.
- rce
Dns Proxy Ip Address This property is required. String - The reverse connection endpoint (RCE) IP address for DNS lookups.
- rce
Traffic Ip Address 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.