Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Connector

This resource provides the Service Connector resource in Oracle Cloud Infrastructure Service Connector Hub service.

Creates a new service connector in the specified compartment. A service connector is a logically defined flow for moving data from a source service to a destination service in Oracle Cloud Infrastructure. For instructions, see To create a service connector. For general information about service connectors, see Service Connector Hub Overview.

For purposes of access control, you must provide the OCID of the compartment where you want the service connector to reside. Notice that the service connector doesn’t have to be in the same compartment as the source or target services. For information about access control and compartments, see Overview of the IAM Service.

After you send your request, the new service connector’s state is temporarily CREATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For instructions on deactivating and activating service connectors, see To activate or deactivate a service connector.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testServiceConnector = new Oci.Sch.Connector("testServiceConnector", new Oci.Sch.ConnectorArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Service_connector_display_name,
            Source = new Oci.Sch.Inputs.ConnectorSourceArgs
            {
                Kind = @var.Service_connector_source_kind,
                Cursor = new Oci.Sch.Inputs.ConnectorSourceCursorArgs
                {
                    Kind = @var.Service_connector_source_cursor_kind,
                },
                LogSources = 
                {
                    new Oci.Sch.Inputs.ConnectorSourceLogSourceArgs
                    {
                        CompartmentId = @var.Compartment_id,
                        LogGroupId = oci_logging_log_group.Test_log_group.Id,
                        LogId = oci_logging_log.Test_log.Id,
                    },
                },
                StreamId = oci_streaming_stream.Test_stream.Id,
            },
            Target = new Oci.Sch.Inputs.ConnectorTargetArgs
            {
                Kind = @var.Service_connector_target_kind,
                BatchRolloverSizeInMbs = @var.Service_connector_target_batch_rollover_size_in_mbs,
                BatchRolloverTimeInMs = @var.Service_connector_target_batch_rollover_time_in_ms,
                Bucket = @var.Service_connector_target_bucket,
                CompartmentId = @var.Compartment_id,
                Dimensions = 
                {
                    new Oci.Sch.Inputs.ConnectorTargetDimensionArgs
                    {
                        DimensionValue = new Oci.Sch.Inputs.ConnectorTargetDimensionDimensionValueArgs
                        {
                            Kind = @var.Service_connector_target_dimensions_dimension_value_kind,
                            Path = @var.Service_connector_target_dimensions_dimension_value_path,
                            Value = @var.Service_connector_target_dimensions_dimension_value_value,
                        },
                        Name = @var.Service_connector_target_dimensions_name,
                    },
                },
                EnableFormattedMessaging = @var.Service_connector_target_enable_formatted_messaging,
                FunctionId = oci_functions_function.Test_function.Id,
                LogGroupId = oci_logging_log_group.Test_log_group.Id,
                Metric = @var.Service_connector_target_metric,
                MetricNamespace = @var.Service_connector_target_metric_namespace,
                Namespace = @var.Service_connector_target_namespace,
                ObjectNamePrefix = @var.Service_connector_target_object_name_prefix,
                StreamId = oci_streaming_stream.Test_stream.Id,
                TopicId = oci_ons_notification_topic.Test_notification_topic.Id,
            },
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            Description = @var.Service_connector_description,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            Tasks = 
            {
                new Oci.Sch.Inputs.ConnectorTaskArgs
                {
                    Kind = @var.Service_connector_tasks_kind,
                    BatchSizeInKbs = @var.Service_connector_tasks_batch_size_in_kbs,
                    BatchTimeInSec = @var.Service_connector_tasks_batch_time_in_sec,
                    Condition = @var.Service_connector_tasks_condition,
                    FunctionId = oci_functions_function.Test_function.Id,
                },
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Sch.NewConnector(ctx, "testServiceConnector", &Sch.ConnectorArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DisplayName:   pulumi.Any(_var.Service_connector_display_name),
			Source: &sch.ConnectorSourceArgs{
				Kind: pulumi.Any(_var.Service_connector_source_kind),
				Cursor: &sch.ConnectorSourceCursorArgs{
					Kind: pulumi.Any(_var.Service_connector_source_cursor_kind),
				},
				LogSources: sch.ConnectorSourceLogSourceArray{
					&sch.ConnectorSourceLogSourceArgs{
						CompartmentId: pulumi.Any(_var.Compartment_id),
						LogGroupId:    pulumi.Any(oci_logging_log_group.Test_log_group.Id),
						LogId:         pulumi.Any(oci_logging_log.Test_log.Id),
					},
				},
				StreamId: pulumi.Any(oci_streaming_stream.Test_stream.Id),
			},
			Target: &sch.ConnectorTargetArgs{
				Kind:                   pulumi.Any(_var.Service_connector_target_kind),
				BatchRolloverSizeInMbs: pulumi.Any(_var.Service_connector_target_batch_rollover_size_in_mbs),
				BatchRolloverTimeInMs:  pulumi.Any(_var.Service_connector_target_batch_rollover_time_in_ms),
				Bucket:                 pulumi.Any(_var.Service_connector_target_bucket),
				CompartmentId:          pulumi.Any(_var.Compartment_id),
				Dimensions: sch.ConnectorTargetDimensionArray{
					&sch.ConnectorTargetDimensionArgs{
						DimensionValue: &sch.ConnectorTargetDimensionDimensionValueArgs{
							Kind:  pulumi.Any(_var.Service_connector_target_dimensions_dimension_value_kind),
							Path:  pulumi.Any(_var.Service_connector_target_dimensions_dimension_value_path),
							Value: pulumi.Any(_var.Service_connector_target_dimensions_dimension_value_value),
						},
						Name: pulumi.Any(_var.Service_connector_target_dimensions_name),
					},
				},
				EnableFormattedMessaging: pulumi.Any(_var.Service_connector_target_enable_formatted_messaging),
				FunctionId:               pulumi.Any(oci_functions_function.Test_function.Id),
				LogGroupId:               pulumi.Any(oci_logging_log_group.Test_log_group.Id),
				Metric:                   pulumi.Any(_var.Service_connector_target_metric),
				MetricNamespace:          pulumi.Any(_var.Service_connector_target_metric_namespace),
				Namespace:                pulumi.Any(_var.Service_connector_target_namespace),
				ObjectNamePrefix:         pulumi.Any(_var.Service_connector_target_object_name_prefix),
				StreamId:                 pulumi.Any(oci_streaming_stream.Test_stream.Id),
				TopicId:                  pulumi.Any(oci_ons_notification_topic.Test_notification_topic.Id),
			},
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(_var.Service_connector_description),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			Tasks: sch.ConnectorTaskArray{
				&sch.ConnectorTaskArgs{
					Kind:           pulumi.Any(_var.Service_connector_tasks_kind),
					BatchSizeInKbs: pulumi.Any(_var.Service_connector_tasks_batch_size_in_kbs),
					BatchTimeInSec: pulumi.Any(_var.Service_connector_tasks_batch_time_in_sec),
					Condition:      pulumi.Any(_var.Service_connector_tasks_condition),
					FunctionId:     pulumi.Any(oci_functions_function.Test_function.Id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_service_connector = oci.sch.Connector("testServiceConnector",
    compartment_id=var["compartment_id"],
    display_name=var["service_connector_display_name"],
    source=oci.sch.ConnectorSourceArgs(
        kind=var["service_connector_source_kind"],
        cursor=oci.sch.ConnectorSourceCursorArgs(
            kind=var["service_connector_source_cursor_kind"],
        ),
        log_sources=[oci.sch.ConnectorSourceLogSourceArgs(
            compartment_id=var["compartment_id"],
            log_group_id=oci_logging_log_group["test_log_group"]["id"],
            log_id=oci_logging_log["test_log"]["id"],
        )],
        stream_id=oci_streaming_stream["test_stream"]["id"],
    ),
    target=oci.sch.ConnectorTargetArgs(
        kind=var["service_connector_target_kind"],
        batch_rollover_size_in_mbs=var["service_connector_target_batch_rollover_size_in_mbs"],
        batch_rollover_time_in_ms=var["service_connector_target_batch_rollover_time_in_ms"],
        bucket=var["service_connector_target_bucket"],
        compartment_id=var["compartment_id"],
        dimensions=[oci.sch.ConnectorTargetDimensionArgs(
            dimension_value=oci.sch.ConnectorTargetDimensionDimensionValueArgs(
                kind=var["service_connector_target_dimensions_dimension_value_kind"],
                path=var["service_connector_target_dimensions_dimension_value_path"],
                value=var["service_connector_target_dimensions_dimension_value_value"],
            ),
            name=var["service_connector_target_dimensions_name"],
        )],
        enable_formatted_messaging=var["service_connector_target_enable_formatted_messaging"],
        function_id=oci_functions_function["test_function"]["id"],
        log_group_id=oci_logging_log_group["test_log_group"]["id"],
        metric=var["service_connector_target_metric"],
        metric_namespace=var["service_connector_target_metric_namespace"],
        namespace=var["service_connector_target_namespace"],
        object_name_prefix=var["service_connector_target_object_name_prefix"],
        stream_id=oci_streaming_stream["test_stream"]["id"],
        topic_id=oci_ons_notification_topic["test_notification_topic"]["id"],
    ),
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=var["service_connector_description"],
    freeform_tags={
        "bar-key": "value",
    },
    tasks=[oci.sch.ConnectorTaskArgs(
        kind=var["service_connector_tasks_kind"],
        batch_size_in_kbs=var["service_connector_tasks_batch_size_in_kbs"],
        batch_time_in_sec=var["service_connector_tasks_batch_time_in_sec"],
        condition=var["service_connector_tasks_condition"],
        function_id=oci_functions_function["test_function"]["id"],
    )])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testServiceConnector = new oci.sch.Connector("testServiceConnector", {
    compartmentId: _var.compartment_id,
    displayName: _var.service_connector_display_name,
    source: {
        kind: _var.service_connector_source_kind,
        cursor: {
            kind: _var.service_connector_source_cursor_kind,
        },
        logSources: [{
            compartmentId: _var.compartment_id,
            logGroupId: oci_logging_log_group.test_log_group.id,
            logId: oci_logging_log.test_log.id,
        }],
        streamId: oci_streaming_stream.test_stream.id,
    },
    target: {
        kind: _var.service_connector_target_kind,
        batchRolloverSizeInMbs: _var.service_connector_target_batch_rollover_size_in_mbs,
        batchRolloverTimeInMs: _var.service_connector_target_batch_rollover_time_in_ms,
        bucket: _var.service_connector_target_bucket,
        compartmentId: _var.compartment_id,
        dimensions: [{
            dimensionValue: {
                kind: _var.service_connector_target_dimensions_dimension_value_kind,
                path: _var.service_connector_target_dimensions_dimension_value_path,
                value: _var.service_connector_target_dimensions_dimension_value_value,
            },
            name: _var.service_connector_target_dimensions_name,
        }],
        enableFormattedMessaging: _var.service_connector_target_enable_formatted_messaging,
        functionId: oci_functions_function.test_function.id,
        logGroupId: oci_logging_log_group.test_log_group.id,
        metric: _var.service_connector_target_metric,
        metricNamespace: _var.service_connector_target_metric_namespace,
        namespace: _var.service_connector_target_namespace,
        objectNamePrefix: _var.service_connector_target_object_name_prefix,
        streamId: oci_streaming_stream.test_stream.id,
        topicId: oci_ons_notification_topic.test_notification_topic.id,
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: _var.service_connector_description,
    freeformTags: {
        "bar-key": "value",
    },
    tasks: [{
        kind: _var.service_connector_tasks_kind,
        batchSizeInKbs: _var.service_connector_tasks_batch_size_in_kbs,
        batchTimeInSec: _var.service_connector_tasks_batch_time_in_sec,
        condition: _var.service_connector_tasks_condition,
        functionId: oci_functions_function.test_function.id,
    }],
});

Coming soon!

Create a Connector Resource

new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);
@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              compartment_id: Optional[str] = None,
              defined_tags: Optional[Mapping[str, Any]] = None,
              description: Optional[str] = None,
              display_name: Optional[str] = None,
              freeform_tags: Optional[Mapping[str, Any]] = None,
              source: Optional[_sch.ConnectorSourceArgs] = None,
              state: Optional[str] = None,
              target: Optional[_sch.ConnectorTargetArgs] = None,
              tasks: Optional[Sequence[_sch.ConnectorTaskArgs]] = None)
@overload
def Connector(resource_name: str,
              args: ConnectorArgs,
              opts: Optional[ResourceOptions] = None)
func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)
type: oci:Sch:Connector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Connector Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Connector resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

DisplayName string

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

Target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) The description of the resource. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

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

State string

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

Tasks List<ConnectorTaskArgs>

(Updatable) The list of tasks.

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

DisplayName string

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

Target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) The description of the resource. Avoid entering confidential information.

FreeformTags map[string]interface{}

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

State string

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

Tasks []ConnectorTaskArgs

(Updatable) The list of tasks.

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

displayName String

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) The description of the resource. Avoid entering confidential information.

freeformTags Map<String,Object>

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

state String

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

tasks List<ConnectorTaskArgs>

(Updatable) The list of tasks.

compartmentId string

(Updatable) The OCID of the compartment containing the metric.

displayName string

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description string

(Updatable) The description of the resource. Avoid entering confidential information.

freeformTags {[key: string]: any}

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

state string

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

tasks ConnectorTaskArgs[]

(Updatable) The list of tasks.

compartment_id str

(Updatable) The OCID of the compartment containing the metric.

display_name str

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description str

(Updatable) The description of the resource. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

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

state str

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

tasks ConnectorTaskArgs]

(Updatable) The list of tasks.

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

displayName String

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

source Property Map

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

target Property Map

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) The description of the resource. Avoid entering confidential information.

freeformTags Map<Any>

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

state String

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

tasks List<Property Map>

(Updatable) The list of tasks.

Outputs

All input properties are implicitly available as output properties. Additionally, the Connector resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

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.

SystemTags Dictionary<string, object>

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}}

TimeCreated string

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

TimeUpdated string

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Id string

The provider-assigned unique ID for this managed resource.

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.

SystemTags map[string]interface{}

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}}

TimeCreated string

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

TimeUpdated string

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

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.

systemTags Map<String,Object>

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}}

timeCreated String

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

timeUpdated String

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

id string

The provider-assigned unique ID for this managed resource.

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.

systemTags {[key: string]: any}

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}}

timeCreated string

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

timeUpdated string

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

id str

The provider-assigned unique ID for this managed resource.

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.

system_tags Mapping[str, Any]

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}}

time_created str

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

time_updated str

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

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.

systemTags Map<Any>

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}}

timeCreated String

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

timeUpdated String

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Look up an Existing Connector Resource

Get an existing Connector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectorState, opts?: CustomResourceOptions): Connector
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecyle_details: Optional[str] = None,
        source: Optional[_sch.ConnectorSourceArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        target: Optional[_sch.ConnectorTargetArgs] = None,
        tasks: Optional[Sequence[_sch.ConnectorTaskArgs]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Connector
func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)
public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)
public static Connector get(String name, Output<String> id, ConnectorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) The description of the resource. Avoid entering confidential information.

DisplayName string

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

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

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.

Source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

State string

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

SystemTags Dictionary<string, object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

Tasks List<ConnectorTaskArgs>

(Updatable) The list of tasks.

TimeCreated string

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

TimeUpdated string

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) The description of the resource. Avoid entering confidential information.

DisplayName string

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

FreeformTags map[string]interface{}

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

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.

Source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

State string

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

SystemTags map[string]interface{}

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

Tasks []ConnectorTaskArgs

(Updatable) The list of tasks.

TimeCreated string

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

TimeUpdated string

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) The description of the resource. Avoid entering confidential information.

displayName String

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags Map<String,Object>

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

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.

source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

state String

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

systemTags Map<String,Object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

tasks List<ConnectorTaskArgs>

(Updatable) The list of tasks.

timeCreated String

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

timeUpdated String

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

compartmentId string

(Updatable) The OCID of the compartment containing the metric.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description string

(Updatable) The description of the resource. Avoid entering confidential information.

displayName string

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags {[key: string]: any}

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

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.

source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

state string

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

systemTags {[key: string]: any}

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

tasks ConnectorTaskArgs[]

(Updatable) The list of tasks.

timeCreated string

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

timeUpdated string

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

compartment_id str

(Updatable) The OCID of the compartment containing the metric.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description str

(Updatable) The description of the resource. Avoid entering confidential information.

display_name str

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

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

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.

source ConnectorSourceArgs

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

state str

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

system_tags Mapping[str, Any]

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

target ConnectorTargetArgs

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

tasks ConnectorTaskArgs]

(Updatable) The list of tasks.

time_created str

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

time_updated str

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) The description of the resource. Avoid entering confidential information.

displayName String

(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags Map<Any>

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

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.

source Property Map

(Updatable) An object that represents the source of the flow defined by the service connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

state String

(Updatable) The target state for the service connector. Could be set to ACTIVE or INACTIVE.

systemTags Map<Any>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

target Property Map

(Updatable) An object that represents the target of the flow defined by the service connector. An example target is a stream (Streaming service). For more information about flows defined by service connectors, see Service Connector Hub Overview. For configuration instructions, see To create a service connector.

tasks List<Property Map>

(Updatable) The list of tasks.

timeCreated String

The date and time when the service connector was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

timeUpdated String

The date and time when the service connector was updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Supporting Types

ConnectorSource

Kind string

(Updatable) The type descriminator.

Cursor ConnectorSourceCursor

(Updatable) The type of cursor, which determines the starting point from which the stream will be consumed.

LogSources List<ConnectorSourceLogSource>

(Updatable) The logs for this Logging source.

StreamId string

(Updatable) The OCID of the stream.

Kind string

(Updatable) The type descriminator.

Cursor ConnectorSourceCursor

(Updatable) The type of cursor, which determines the starting point from which the stream will be consumed.

LogSources []ConnectorSourceLogSource

(Updatable) The logs for this Logging source.

StreamId string

(Updatable) The OCID of the stream.

kind String

(Updatable) The type descriminator.

cursor ConnectorSourceCursor

(Updatable) The type of cursor, which determines the starting point from which the stream will be consumed.

logSources List<ConnectorSourceLogSource>

(Updatable) The logs for this Logging source.

streamId String

(Updatable) The OCID of the stream.

kind string

(Updatable) The type descriminator.

cursor ConnectorSourceCursor

(Updatable) The type of cursor, which determines the starting point from which the stream will be consumed.

logSources ConnectorSourceLogSource[]

(Updatable) The logs for this Logging source.

streamId string

(Updatable) The OCID of the stream.

kind str

(Updatable) The type descriminator.

cursor ConnectorSourceCursor

(Updatable) The type of cursor, which determines the starting point from which the stream will be consumed.

log_sources ConnectorSourceLogSource]

(Updatable) The logs for this Logging source.

stream_id str

(Updatable) The OCID of the stream.

kind String

(Updatable) The type descriminator.

cursor Property Map

(Updatable) The type of cursor, which determines the starting point from which the stream will be consumed.

logSources List<Property Map>

(Updatable) The logs for this Logging source.

streamId String

(Updatable) The OCID of the stream.

ConnectorSourceCursor

Kind string

(Updatable) The type descriminator.

Kind string

(Updatable) The type descriminator.

kind String

(Updatable) The type descriminator.

kind string

(Updatable) The type descriminator.

kind str

(Updatable) The type descriminator.

kind String

(Updatable) The type descriminator.

ConnectorSourceLogSource

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

LogGroupId string

(Updatable) The OCID of the Logging Analytics log group.

LogId string

(Updatable) The OCID of the log.

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

LogGroupId string

(Updatable) The OCID of the Logging Analytics log group.

LogId string

(Updatable) The OCID of the log.

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

logGroupId String

(Updatable) The OCID of the Logging Analytics log group.

logId String

(Updatable) The OCID of the log.

compartmentId string

(Updatable) The OCID of the compartment containing the metric.

logGroupId string

(Updatable) The OCID of the Logging Analytics log group.

logId string

(Updatable) The OCID of the log.

compartment_id str

(Updatable) The OCID of the compartment containing the metric.

log_group_id str

(Updatable) The OCID of the Logging Analytics log group.

log_id str

(Updatable) The OCID of the log.

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

logGroupId String

(Updatable) The OCID of the Logging Analytics log group.

logId String

(Updatable) The OCID of the log.

ConnectorTarget

Kind string

(Updatable) The type descriminator.

BatchRolloverSizeInMbs int

(Updatable) The batch rollover size in megabytes.

BatchRolloverTimeInMs int

(Updatable) The batch rollover time in milliseconds.

Bucket string

(Updatable) The name of the bucket. Avoid entering confidential information.

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

Dimensions List<ConnectorTargetDimension>

(Updatable) List of dimension names and values.

EnableFormattedMessaging bool

(Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol. Example: true

FunctionId string

(Updatable) The OCID of the function to be used as a task.

LogGroupId string

(Updatable) The OCID of the Logging Analytics log group.

Metric string

(Updatable) The name of the metric. Example: CpuUtilization

MetricNamespace string

(Updatable) The namespace of the metric. Example: oci_computeagent

Namespace string

(Updatable) The namespace.

ObjectNamePrefix string

(Updatable) The prefix of the objects. Avoid entering confidential information.

StreamId string

(Updatable) The OCID of the stream.

TopicId string

(Updatable) The OCID of the topic.

Kind string

(Updatable) The type descriminator.

BatchRolloverSizeInMbs int

(Updatable) The batch rollover size in megabytes.

BatchRolloverTimeInMs int

(Updatable) The batch rollover time in milliseconds.

Bucket string

(Updatable) The name of the bucket. Avoid entering confidential information.

CompartmentId string

(Updatable) The OCID of the compartment containing the metric.

Dimensions []ConnectorTargetDimension

(Updatable) List of dimension names and values.

EnableFormattedMessaging bool

(Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol. Example: true

FunctionId string

(Updatable) The OCID of the function to be used as a task.

LogGroupId string

(Updatable) The OCID of the Logging Analytics log group.

Metric string

(Updatable) The name of the metric. Example: CpuUtilization

MetricNamespace string

(Updatable) The namespace of the metric. Example: oci_computeagent

Namespace string

(Updatable) The namespace.

ObjectNamePrefix string

(Updatable) The prefix of the objects. Avoid entering confidential information.

StreamId string

(Updatable) The OCID of the stream.

TopicId string

(Updatable) The OCID of the topic.

kind String

(Updatable) The type descriminator.

batchRolloverSizeInMbs Integer

(Updatable) The batch rollover size in megabytes.

batchRolloverTimeInMs Integer

(Updatable) The batch rollover time in milliseconds.

bucket String

(Updatable) The name of the bucket. Avoid entering confidential information.

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

dimensions List<ConnectorTargetDimension>

(Updatable) List of dimension names and values.

enableFormattedMessaging Boolean

(Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol. Example: true

functionId String

(Updatable) The OCID of the function to be used as a task.

logGroupId String

(Updatable) The OCID of the Logging Analytics log group.

metric String

(Updatable) The name of the metric. Example: CpuUtilization

metricNamespace String

(Updatable) The namespace of the metric. Example: oci_computeagent

namespace String

(Updatable) The namespace.

objectNamePrefix String

(Updatable) The prefix of the objects. Avoid entering confidential information.

streamId String

(Updatable) The OCID of the stream.

topicId String

(Updatable) The OCID of the topic.

kind string

(Updatable) The type descriminator.

batchRolloverSizeInMbs number

(Updatable) The batch rollover size in megabytes.

batchRolloverTimeInMs number

(Updatable) The batch rollover time in milliseconds.

bucket string

(Updatable) The name of the bucket. Avoid entering confidential information.

compartmentId string

(Updatable) The OCID of the compartment containing the metric.

dimensions ConnectorTargetDimension[]

(Updatable) List of dimension names and values.

enableFormattedMessaging boolean

(Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol. Example: true

functionId string

(Updatable) The OCID of the function to be used as a task.

logGroupId string

(Updatable) The OCID of the Logging Analytics log group.

metric string

(Updatable) The name of the metric. Example: CpuUtilization

metricNamespace string

(Updatable) The namespace of the metric. Example: oci_computeagent

namespace string

(Updatable) The namespace.

objectNamePrefix string

(Updatable) The prefix of the objects. Avoid entering confidential information.

streamId string

(Updatable) The OCID of the stream.

topicId string

(Updatable) The OCID of the topic.

kind str

(Updatable) The type descriminator.

batch_rollover_size_in_mbs int

(Updatable) The batch rollover size in megabytes.

batch_rollover_time_in_ms int

(Updatable) The batch rollover time in milliseconds.

bucket str

(Updatable) The name of the bucket. Avoid entering confidential information.

compartment_id str

(Updatable) The OCID of the compartment containing the metric.

dimensions ConnectorTargetDimension]

(Updatable) List of dimension names and values.

enable_formatted_messaging bool

(Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol. Example: true

function_id str

(Updatable) The OCID of the function to be used as a task.

log_group_id str

(Updatable) The OCID of the Logging Analytics log group.

metric str

(Updatable) The name of the metric. Example: CpuUtilization

metric_namespace str

(Updatable) The namespace of the metric. Example: oci_computeagent

namespace str

(Updatable) The namespace.

object_name_prefix str

(Updatable) The prefix of the objects. Avoid entering confidential information.

stream_id str

(Updatable) The OCID of the stream.

topic_id str

(Updatable) The OCID of the topic.

kind String

(Updatable) The type descriminator.

batchRolloverSizeInMbs Number

(Updatable) The batch rollover size in megabytes.

batchRolloverTimeInMs Number

(Updatable) The batch rollover time in milliseconds.

bucket String

(Updatable) The name of the bucket. Avoid entering confidential information.

compartmentId String

(Updatable) The OCID of the compartment containing the metric.

dimensions List<Property Map>

(Updatable) List of dimension names and values.

enableFormattedMessaging Boolean

(Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol. Example: true

functionId String

(Updatable) The OCID of the function to be used as a task.

logGroupId String

(Updatable) The OCID of the Logging Analytics log group.

metric String

(Updatable) The name of the metric. Example: CpuUtilization

metricNamespace String

(Updatable) The namespace of the metric. Example: oci_computeagent

namespace String

(Updatable) The namespace.

objectNamePrefix String

(Updatable) The prefix of the objects. Avoid entering confidential information.

streamId String

(Updatable) The OCID of the stream.

topicId String

(Updatable) The OCID of the topic.

ConnectorTargetDimension

DimensionValue ConnectorTargetDimensionDimensionValue

(Updatable) 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

(Updatable) 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 Service Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails Reference. Example: type

DimensionValue ConnectorTargetDimensionDimensionValue

(Updatable) 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

(Updatable) 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 Service Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails Reference. Example: type

dimensionValue ConnectorTargetDimensionDimensionValue

(Updatable) 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

(Updatable) 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 Service Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails Reference. Example: type

dimensionValue ConnectorTargetDimensionDimensionValue

(Updatable) 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

(Updatable) 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 Service 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_value ConnectorTargetDimensionDimensionValue

(Updatable) 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

(Updatable) 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 Service Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails Reference. Example: type

dimensionValue Property Map

(Updatable) 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

(Updatable) 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 Service Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails Reference. Example: type

ConnectorTargetDimensionDimensionValue

Kind string

(Updatable) The type descriminator.

Path string

(Updatable) 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

(Updatable) 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

(Updatable) The type descriminator.

Path string

(Updatable) 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

(Updatable) 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

(Updatable) The type descriminator.

path String

(Updatable) 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

(Updatable) 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

(Updatable) The type descriminator.

path string

(Updatable) 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

(Updatable) 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

(Updatable) The type descriminator.

path str

(Updatable) 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

(Updatable) 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

(Updatable) The type descriminator.

path String

(Updatable) 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

(Updatable) 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.

ConnectorTask

Kind string

(Updatable) The type descriminator.

BatchSizeInKbs int

(Updatable) Size limit (kilobytes) for batch sent to invoke the function.

BatchTimeInSec int

(Updatable) Time limit (seconds) for batch sent to invoke the function.

Condition string

(Updatable) A filter or mask to limit the source used in the flow defined by the service connector.

FunctionId string

(Updatable) The OCID of the function to be used as a task.

Kind string

(Updatable) The type descriminator.

BatchSizeInKbs int

(Updatable) Size limit (kilobytes) for batch sent to invoke the function.

BatchTimeInSec int

(Updatable) Time limit (seconds) for batch sent to invoke the function.

Condition string

(Updatable) A filter or mask to limit the source used in the flow defined by the service connector.

FunctionId string

(Updatable) The OCID of the function to be used as a task.

kind String

(Updatable) The type descriminator.

batchSizeInKbs Integer

(Updatable) Size limit (kilobytes) for batch sent to invoke the function.

batchTimeInSec Integer

(Updatable) Time limit (seconds) for batch sent to invoke the function.

condition String

(Updatable) A filter or mask to limit the source used in the flow defined by the service connector.

functionId String

(Updatable) The OCID of the function to be used as a task.

kind string

(Updatable) The type descriminator.

batchSizeInKbs number

(Updatable) Size limit (kilobytes) for batch sent to invoke the function.

batchTimeInSec number

(Updatable) Time limit (seconds) for batch sent to invoke the function.

condition string

(Updatable) A filter or mask to limit the source used in the flow defined by the service connector.

functionId string

(Updatable) The OCID of the function to be used as a task.

kind str

(Updatable) The type descriminator.

batch_size_in_kbs int

(Updatable) Size limit (kilobytes) for batch sent to invoke the function.

batch_time_in_sec int

(Updatable) Time limit (seconds) for batch sent to invoke the function.

condition str

(Updatable) A filter or mask to limit the source used in the flow defined by the service connector.

function_id str

(Updatable) The OCID of the function to be used as a task.

kind String

(Updatable) The type descriminator.

batchSizeInKbs Number

(Updatable) Size limit (kilobytes) for batch sent to invoke the function.

batchTimeInSec Number

(Updatable) Time limit (seconds) for batch sent to invoke the function.

condition String

(Updatable) A filter or mask to limit the source used in the flow defined by the service connector.

functionId String

(Updatable) The OCID of the function to be used as a task.

Import

ServiceConnectors can be imported using the id, e.g.

 $ pulumi import oci:Sch/connector:Connector test_service_connector "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.