1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Sch
  5. getServiceConnector
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Sch.getServiceConnector

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This data source provides details about a specific Service Connector resource in Oracle Cloud Infrastructure Service Connector Hub service.

    Gets the specified connector’s configuration information. For more information, see Getting a Connector.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testServiceConnector = oci.Sch.getServiceConnector({
        serviceConnectorId: testServiceConnectorOciSchServiceConnector.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_service_connector = oci.Sch.get_service_connector(service_connector_id=test_service_connector_oci_sch_service_connector["id"])
    
    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.GetServiceConnector(ctx, &sch.GetServiceConnectorArgs{
    			ServiceConnectorId: testServiceConnectorOciSchServiceConnector.Id,
    		}, 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 testServiceConnector = Oci.Sch.GetServiceConnector.Invoke(new()
        {
            ServiceConnectorId = testServiceConnectorOciSchServiceConnector.Id,
        });
    
    });
    
    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.GetServiceConnectorArgs;
    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 testServiceConnector = SchFunctions.getServiceConnector(GetServiceConnectorArgs.builder()
                .serviceConnectorId(testServiceConnectorOciSchServiceConnector.id())
                .build());
    
        }
    }
    
    variables:
      testServiceConnector:
        fn::invoke:
          Function: oci:Sch:getServiceConnector
          Arguments:
            serviceConnectorId: ${testServiceConnectorOciSchServiceConnector.id}
    

    Using getServiceConnector

    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 getServiceConnector(args: GetServiceConnectorArgs, opts?: InvokeOptions): Promise<GetServiceConnectorResult>
    function getServiceConnectorOutput(args: GetServiceConnectorOutputArgs, opts?: InvokeOptions): Output<GetServiceConnectorResult>
    def get_service_connector(service_connector_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetServiceConnectorResult
    def get_service_connector_output(service_connector_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetServiceConnectorResult]
    func GetServiceConnector(ctx *Context, args *GetServiceConnectorArgs, opts ...InvokeOption) (*GetServiceConnectorResult, error)
    func GetServiceConnectorOutput(ctx *Context, args *GetServiceConnectorOutputArgs, opts ...InvokeOption) GetServiceConnectorResultOutput

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

    public static class GetServiceConnector 
    {
        public static Task<GetServiceConnectorResult> InvokeAsync(GetServiceConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceConnectorResult> Invoke(GetServiceConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceConnectorResult> getServiceConnector(GetServiceConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Sch/getServiceConnector:getServiceConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ServiceConnectorId string
    The OCID of the connector.
    ServiceConnectorId string
    The OCID of the connector.
    serviceConnectorId String
    The OCID of the connector.
    serviceConnectorId string
    The OCID of the connector.
    service_connector_id str
    The OCID of the connector.
    serviceConnectorId String
    The OCID of the connector.

    getServiceConnector Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing the metric.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The description of the resource. Avoid entering confidential information.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
    FreeformTags 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 string
    The OCID of the connector.
    LifecyleDetails 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.
    ServiceConnectorId string
    Sources List<GetServiceConnectorSource>
    An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    State string
    The current state of the connector.
    SystemTags 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 List<GetServiceConnectorTarget>
    An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    Tasks List<GetServiceConnectorTask>
    The list of tasks.
    TimeCreated string
    The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    TimeUpdated string
    The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment containing the metric.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The description of the resource. Avoid entering confidential information.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
    FreeformTags 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 string
    The OCID of the connector.
    LifecyleDetails 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.
    ServiceConnectorId string
    Sources []GetServiceConnectorSource
    An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    State string
    The current state of the connector.
    SystemTags 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 []GetServiceConnectorTarget
    An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    Tasks []GetServiceConnectorTask
    The list of tasks.
    TimeCreated string
    The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    TimeUpdated string
    The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment containing the metric.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The description of the resource. Avoid entering confidential information.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
    freeformTags 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 String
    The OCID of the connector.
    lifecyleDetails 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.
    serviceConnectorId String
    sources List<GetServiceConnectorSource>
    An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    state String
    The current state of the connector.
    systemTags 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 List<GetServiceConnectorTarget>
    An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    tasks List<GetServiceConnectorTask>
    The list of tasks.
    timeCreated String
    The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    timeUpdated String
    The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment containing the metric.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    The description of the resource. Avoid entering confidential information.
    displayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
    freeformTags {[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 string
    The OCID of the connector.
    lifecyleDetails 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.
    serviceConnectorId string
    sources GetServiceConnectorSource[]
    An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    state string
    The current state of the connector.
    systemTags {[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 GetServiceConnectorTarget[]
    An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    tasks GetServiceConnectorTask[]
    The list of tasks.
    timeCreated string
    The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    timeUpdated string
    The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment containing the metric.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    The description of the resource. Avoid entering confidential information.
    display_name str
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
    freeform_tags 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 str
    The OCID of the connector.
    lifecyle_details 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.
    service_connector_id str
    sources Sequence[sch.GetServiceConnectorSource]
    An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    state str
    The current state of the connector.
    system_tags 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 Sequence[sch.GetServiceConnectorTarget]
    An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    tasks Sequence[sch.GetServiceConnectorTask]
    The list of tasks.
    time_created str
    The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    time_updated str
    The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment containing the metric.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The description of the resource. Avoid entering confidential information.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
    freeformTags 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 String
    The OCID of the connector.
    lifecyleDetails 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.
    serviceConnectorId String
    sources List<Property Map>
    An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    state String
    The current state of the connector.
    systemTags 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 List<Property Map>
    An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.
    tasks List<Property Map>
    The list of tasks.
    timeCreated String
    The date and time when the connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
    timeUpdated String
    The date and time when the connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

    Supporting Types

    GetServiceConnectorSource

    ConfigMap 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)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
    Cursors List<GetServiceConnectorSourceCursor>
    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 string
    The type discriminator.
    LogSources List<GetServiceConnectorSourceLogSource>
    The logs for this Logging source.
    MonitoringSources List<GetServiceConnectorSourceMonitoringSource>
    One or more compartment-specific lists of metric namespaces to retrieve data from.
    PluginName 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)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
    StreamId string
    The OCID of the stream.
    ConfigMap 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)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
    Cursors []GetServiceConnectorSourceCursor
    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 string
    The type discriminator.
    LogSources []GetServiceConnectorSourceLogSource
    The logs for this Logging source.
    MonitoringSources []GetServiceConnectorSourceMonitoringSource
    One or more compartment-specific lists of metric namespaces to retrieve data from.
    PluginName 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)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
    StreamId string
    The OCID of the stream.
    configMap 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)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
    cursors List<GetServiceConnectorSourceCursor>
    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 String
    The type discriminator.
    logSources List<GetServiceConnectorSourceLogSource>
    The logs for this Logging source.
    monitoringSources List<GetServiceConnectorSourceMonitoringSource>
    One or more compartment-specific lists of metric namespaces to retrieve data from.
    pluginName 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)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
    streamId String
    The OCID of the stream.
    configMap 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)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
    cursors GetServiceConnectorSourceCursor[]
    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 string
    The type discriminator.
    logSources GetServiceConnectorSourceLogSource[]
    The logs for this Logging source.
    monitoringSources GetServiceConnectorSourceMonitoringSource[]
    One or more compartment-specific lists of metric namespaces to retrieve data from.
    pluginName 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)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
    streamId string
    The OCID of the stream.
    config_map 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)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
    cursors Sequence[sch.GetServiceConnectorSourceCursor]
    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 str
    The type discriminator.
    log_sources Sequence[sch.GetServiceConnectorSourceLogSource]
    The logs for this Logging source.
    monitoring_sources Sequence[sch.GetServiceConnectorSourceMonitoringSource]
    One or more compartment-specific lists of metric namespaces to retrieve data from.
    plugin_name 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)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
    stream_id str
    The OCID of the stream.
    configMap 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)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
    cursors 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 String
    The type discriminator.
    logSources List<Property Map>
    The logs for this Logging source.
    monitoringSources List<Property Map>
    One or more compartment-specific lists of metric namespaces to retrieve data from.
    pluginName 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)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
    streamId String
    The OCID of the stream.

    GetServiceConnectorSourceCursor

    Kind string
    The type discriminator.
    Kind string
    The type discriminator.
    kind String
    The type discriminator.
    kind string
    The type discriminator.
    kind str
    The type discriminator.
    kind String
    The type discriminator.

    GetServiceConnectorSourceLogSource

    CompartmentId string
    The OCID of the compartment containing the metric.
    LogGroupId string
    The OCID of the Logging Analytics log group.
    LogId string
    The OCID of the log.
    CompartmentId string
    The OCID of the compartment containing the metric.
    LogGroupId string
    The OCID of the Logging Analytics log group.
    LogId string
    The OCID of the log.
    compartmentId String
    The OCID of the compartment containing the metric.
    logGroupId String
    The OCID of the Logging Analytics log group.
    logId String
    The OCID of the log.
    compartmentId string
    The OCID of the compartment containing the metric.
    logGroupId string
    The OCID of the Logging Analytics log group.
    logId string
    The OCID of the log.
    compartment_id str
    The OCID of the compartment containing the metric.
    log_group_id str
    The OCID of the Logging Analytics log group.
    log_id str
    The OCID of the log.
    compartmentId String
    The OCID of the compartment containing the metric.
    logGroupId String
    The OCID of the Logging Analytics log group.
    logId String
    The OCID of the log.

    GetServiceConnectorSourceMonitoringSource

    CompartmentId string
    The OCID of the compartment containing the metric.
    NamespaceDetails List<GetServiceConnectorSourceMonitoringSourceNamespaceDetail>
    Discriminator for namespaces in the compartment-specific list.
    CompartmentId string
    The OCID of the compartment containing the metric.
    NamespaceDetails []GetServiceConnectorSourceMonitoringSourceNamespaceDetail
    Discriminator for namespaces in the compartment-specific list.
    compartmentId String
    The OCID of the compartment containing the metric.
    namespaceDetails List<GetServiceConnectorSourceMonitoringSourceNamespaceDetail>
    Discriminator for namespaces in the compartment-specific list.
    compartmentId string
    The OCID of the compartment containing the metric.
    namespaceDetails GetServiceConnectorSourceMonitoringSourceNamespaceDetail[]
    Discriminator for namespaces in the compartment-specific list.
    compartment_id str
    The OCID of the compartment containing the metric.
    namespace_details Sequence[sch.GetServiceConnectorSourceMonitoringSourceNamespaceDetail]
    Discriminator for namespaces in the compartment-specific list.
    compartmentId String
    The OCID of the compartment containing the metric.
    namespaceDetails List<Property Map>
    Discriminator for namespaces in the compartment-specific list.

    GetServiceConnectorSourceMonitoringSourceNamespaceDetail

    Kind string
    The type discriminator.
    Namespaces List<GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace>
    The namespaces for the compartment-specific list.
    Kind string
    The type discriminator.
    Namespaces []GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace
    The namespaces for the compartment-specific list.
    kind String
    The type discriminator.
    namespaces List<GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace>
    The namespaces for the compartment-specific list.
    kind string
    The type discriminator.
    namespaces GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace[]
    The namespaces for the compartment-specific list.
    kind str
    The type discriminator.
    namespaces Sequence[sch.GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace]
    The namespaces for the compartment-specific list.
    kind String
    The type discriminator.
    namespaces List<Property Map>
    The namespaces for the compartment-specific list.

    GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace

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

    GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespaceMetric

    Kind string
    The type discriminator.
    Kind string
    The type discriminator.
    kind String
    The type discriminator.
    kind string
    The type discriminator.
    kind str
    The type discriminator.
    kind String
    The type discriminator.

    GetServiceConnectorTarget

    BatchRolloverSizeInMbs int
    The batch rollover size in megabytes.
    BatchRolloverTimeInMs int
    The batch rollover time in milliseconds.
    BatchSizeInKbs int
    Size limit (kilobytes) for batch sent to invoke the function.
    BatchSizeInNum int
    The batch rollover size in number of messages.
    BatchTimeInSec int
    Time limit (seconds) for batch sent to invoke the function.
    Bucket 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 string
    The OCID of the compartment containing the metric.
    Dimensions List<GetServiceConnectorTargetDimension>
    List of dimension names and values.
    EnableFormattedMessaging 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 string
    The OCID of the function to be used as a task.
    Kind string
    The type discriminator.
    LogGroupId string
    The OCID of the Logging Analytics log group.
    LogSourceIdentifier 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 string
    The name of the metric. Example: CpuUtilization
    MetricNamespace string
    The namespace of the metric. Example: oci_computeagent
    Namespace string
    The namespace.
    ObjectNamePrefix string
    The prefix of the objects. Avoid entering confidential information.
    StreamId string
    The OCID of the stream.
    TopicId string
    The OCID of the topic.
    BatchRolloverSizeInMbs int
    The batch rollover size in megabytes.
    BatchRolloverTimeInMs int
    The batch rollover time in milliseconds.
    BatchSizeInKbs int
    Size limit (kilobytes) for batch sent to invoke the function.
    BatchSizeInNum int
    The batch rollover size in number of messages.
    BatchTimeInSec int
    Time limit (seconds) for batch sent to invoke the function.
    Bucket 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 string
    The OCID of the compartment containing the metric.
    Dimensions []GetServiceConnectorTargetDimension
    List of dimension names and values.
    EnableFormattedMessaging 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 string
    The OCID of the function to be used as a task.
    Kind string
    The type discriminator.
    LogGroupId string
    The OCID of the Logging Analytics log group.
    LogSourceIdentifier 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 string
    The name of the metric. Example: CpuUtilization
    MetricNamespace string
    The namespace of the metric. Example: oci_computeagent
    Namespace string
    The namespace.
    ObjectNamePrefix string
    The prefix of the objects. Avoid entering confidential information.
    StreamId string
    The OCID of the stream.
    TopicId string
    The OCID of the topic.
    batchRolloverSizeInMbs Integer
    The batch rollover size in megabytes.
    batchRolloverTimeInMs Integer
    The batch rollover time in milliseconds.
    batchSizeInKbs Integer
    Size limit (kilobytes) for batch sent to invoke the function.
    batchSizeInNum Integer
    The batch rollover size in number of messages.
    batchTimeInSec Integer
    Time limit (seconds) for batch sent to invoke the function.
    bucket 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 String
    The OCID of the compartment containing the metric.
    dimensions List<GetServiceConnectorTargetDimension>
    List of dimension names and values.
    enableFormattedMessaging 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 String
    The OCID of the function to be used as a task.
    kind String
    The type discriminator.
    logGroupId String
    The OCID of the Logging Analytics log group.
    logSourceIdentifier 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 String
    The name of the metric. Example: CpuUtilization
    metricNamespace String
    The namespace of the metric. Example: oci_computeagent
    namespace String
    The namespace.
    objectNamePrefix String
    The prefix of the objects. Avoid entering confidential information.
    streamId String
    The OCID of the stream.
    topicId String
    The OCID of the topic.
    batchRolloverSizeInMbs number
    The batch rollover size in megabytes.
    batchRolloverTimeInMs number
    The batch rollover time in milliseconds.
    batchSizeInKbs number
    Size limit (kilobytes) for batch sent to invoke the function.
    batchSizeInNum number
    The batch rollover size in number of messages.
    batchTimeInSec number
    Time limit (seconds) for batch sent to invoke the function.
    bucket 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 string
    The OCID of the compartment containing the metric.
    dimensions GetServiceConnectorTargetDimension[]
    List of dimension names and values.
    enableFormattedMessaging 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 string
    The OCID of the function to be used as a task.
    kind string
    The type discriminator.
    logGroupId string
    The OCID of the Logging Analytics log group.
    logSourceIdentifier 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 string
    The name of the metric. Example: CpuUtilization
    metricNamespace string
    The namespace of the metric. Example: oci_computeagent
    namespace string
    The namespace.
    objectNamePrefix string
    The prefix of the objects. Avoid entering confidential information.
    streamId string
    The OCID of the stream.
    topicId string
    The OCID of the topic.
    batch_rollover_size_in_mbs int
    The batch rollover size in megabytes.
    batch_rollover_time_in_ms int
    The batch rollover time in milliseconds.
    batch_size_in_kbs int
    Size limit (kilobytes) for batch sent to invoke the function.
    batch_size_in_num int
    The batch rollover size in number of messages.
    batch_time_in_sec int
    Time limit (seconds) for batch sent to invoke the function.
    bucket 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 str
    The OCID of the compartment containing the metric.
    dimensions Sequence[sch.GetServiceConnectorTargetDimension]
    List of dimension names and values.
    enable_formatted_messaging 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 str
    The OCID of the function to be used as a task.
    kind str
    The type discriminator.
    log_group_id str
    The OCID of the Logging Analytics log group.
    log_source_identifier 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 str
    The name of the metric. Example: CpuUtilization
    metric_namespace str
    The namespace of the metric. Example: oci_computeagent
    namespace str
    The namespace.
    object_name_prefix str
    The prefix of the objects. Avoid entering confidential information.
    stream_id str
    The OCID of the stream.
    topic_id str
    The OCID of the topic.
    batchRolloverSizeInMbs Number
    The batch rollover size in megabytes.
    batchRolloverTimeInMs Number
    The batch rollover time in milliseconds.
    batchSizeInKbs Number
    Size limit (kilobytes) for batch sent to invoke the function.
    batchSizeInNum Number
    The batch rollover size in number of messages.
    batchTimeInSec Number
    Time limit (seconds) for batch sent to invoke the function.
    bucket 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 String
    The OCID of the compartment containing the metric.
    dimensions List<Property Map>
    List of dimension names and values.
    enableFormattedMessaging 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 String
    The OCID of the function to be used as a task.
    kind String
    The type discriminator.
    logGroupId String
    The OCID of the Logging Analytics log group.
    logSourceIdentifier 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 String
    The name of the metric. Example: CpuUtilization
    metricNamespace String
    The namespace of the metric. Example: oci_computeagent
    namespace String
    The namespace.
    objectNamePrefix String
    The prefix of the objects. Avoid entering confidential information.
    streamId String
    The OCID of the stream.
    topicId String
    The OCID of the topic.

    GetServiceConnectorTargetDimension

    DimensionValues List<GetServiceConnectorTargetDimensionDimensionValue>
    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 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 []GetServiceConnectorTargetDimensionDimensionValue
    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 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 List<GetServiceConnectorTargetDimensionDimensionValue>
    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 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 GetServiceConnectorTargetDimensionDimensionValue[]
    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 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 Sequence[sch.GetServiceConnectorTargetDimensionDimensionValue]
    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 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 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 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

    GetServiceConnectorTargetDimensionDimensionValue

    Kind string
    The type discriminator.
    Path 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 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 string
    The type discriminator.
    Path 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 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 String
    The type discriminator.
    path 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 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 string
    The type discriminator.
    path 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 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 str
    The type discriminator.
    path 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 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 String
    The type discriminator.
    path 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 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.

    GetServiceConnectorTask

    BatchSizeInKbs int
    Size limit (kilobytes) for batch sent to invoke the function.
    BatchTimeInSec int
    Time limit (seconds) for batch sent to invoke the function.
    Condition string
    A filter or mask to limit the source used in the flow defined by the connector.
    FunctionId string
    The OCID of the function to be used as a task.
    Kind string
    The type discriminator.
    BatchSizeInKbs int
    Size limit (kilobytes) for batch sent to invoke the function.
    BatchTimeInSec int
    Time limit (seconds) for batch sent to invoke the function.
    Condition string
    A filter or mask to limit the source used in the flow defined by the connector.
    FunctionId string
    The OCID of the function to be used as a task.
    Kind string
    The type discriminator.
    batchSizeInKbs Integer
    Size limit (kilobytes) for batch sent to invoke the function.
    batchTimeInSec Integer
    Time limit (seconds) for batch sent to invoke the function.
    condition String
    A filter or mask to limit the source used in the flow defined by the connector.
    functionId String
    The OCID of the function to be used as a task.
    kind String
    The type discriminator.
    batchSizeInKbs number
    Size limit (kilobytes) for batch sent to invoke the function.
    batchTimeInSec number
    Time limit (seconds) for batch sent to invoke the function.
    condition string
    A filter or mask to limit the source used in the flow defined by the connector.
    functionId string
    The OCID of the function to be used as a task.
    kind string
    The type discriminator.
    batch_size_in_kbs int
    Size limit (kilobytes) for batch sent to invoke the function.
    batch_time_in_sec int
    Time limit (seconds) for batch sent to invoke the function.
    condition str
    A filter or mask to limit the source used in the flow defined by the connector.
    function_id str
    The OCID of the function to be used as a task.
    kind str
    The type discriminator.
    batchSizeInKbs Number
    Size limit (kilobytes) for batch sent to invoke the function.
    batchTimeInSec Number
    Time limit (seconds) for batch sent to invoke the function.
    condition String
    A filter or mask to limit the source used in the flow defined by the connector.
    functionId String
    The OCID of the function to be used as a task.
    kind String
    The type discriminator.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi