Oracle Cloud Infrastructure v2.31.0, Apr 17 25

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

oci.GoldenGate.getPipeline

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testPipeline = oci.GoldenGate.getPipeline({
    pipelineId: testPipelineOciGoldenGatePipeline.id,
});

import pulumi
import pulumi_oci as oci

test_pipeline = oci.GoldenGate.get_pipeline(pipeline_id=test_pipeline_oci_golden_gate_pipeline["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := goldengate.GetPipeline(ctx, &goldengate.GetPipelineArgs{
			PipelineId: testPipelineOciGoldenGatePipeline.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 testPipeline = Oci.GoldenGate.GetPipeline.Invoke(new()
    {
        PipelineId = testPipelineOciGoldenGatePipeline.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.GoldenGateFunctions;
import com.pulumi.oci.GoldenGate.inputs.GetPipelineArgs;
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 testPipeline = GoldenGateFunctions.getPipeline(GetPipelineArgs.builder()
            .pipelineId(testPipelineOciGoldenGatePipeline.id())
            .build());

    }
}

variables:
  testPipeline:
    fn::invoke:
      function: oci:GoldenGate:getPipeline
      arguments:
        pipelineId: ${testPipelineOciGoldenGatePipeline.id}

Using getPipeline

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.

TypeScript
Python
Go
C#
Java
YAML

function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>

def get_pipeline(pipeline_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(pipeline_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]

func GetPipeline(ctx *Context, args *GetPipelineArgs, opts ...InvokeOption) (*GetPipelineResult, error)
func GetPipelineOutput(ctx *Context, args *GetPipelineOutputArgs, opts ...InvokeOption) GetPipelineResultOutput

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

public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
public static Output<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)

fn::invoke:
  function: oci:GoldenGate/getPipeline:getPipeline
  arguments:
    # arguments dictionary

The following arguments are supported:

PipelineId string: The OCID of the pipeline created.

PipelineId string: The OCID of the pipeline created.

pipelineId String: The OCID of the pipeline created.

pipelineId string: The OCID of the pipeline created.

pipeline_id str: The OCID of the pipeline created.

pipelineId String: The OCID of the pipeline created.

getPipeline Result

The following output properties are available:

CompartmentId string: The OCID of the compartment being referenced.
CpuCoreCount int: The Minimum number of OCPUs to be made available for this Deployment.
DefinedTags Dictionary<string, string>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
FreeformTags Dictionary<string, string>: A 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 pipeline. This option applies when retrieving a pipeline.
IsAutoScalingEnabled bool: Indicates if auto scaling is enabled for the Deployment's CPU core count.
LicenseModel string: The Oracle license model that applies to a Deployment.
LifecycleDetails string: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
LifecycleSubState string: Possible lifecycle substates when retrieving a pipeline.
Locks List<GetPipelineLock>: Locks associated with this resource.
MappingRules List<GetPipelineMappingRule>: Mapping for source/target schema/tables for the pipeline data replication.
PipelineDiagnosticDatas List<GetPipelinePipelineDiagnosticData>: Information regarding the pipeline diagnostic collection
PipelineId string
ProcessOptions List<GetPipelineProcessOption>: Required pipeline options to configure the replication process (Extract or Replicat).
RecipeType string: The type of the recipe
SourceConnectionDetails List<GetPipelineSourceConnectionDetail>: The source connection details for creating a pipeline.
State string: Lifecycle state of the pipeline.
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}}
TargetConnectionDetails List<GetPipelineTargetConnectionDetail>: The target connection details for creating a pipeline.
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeLastRecorded string: When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

CompartmentId string: The OCID of the compartment being referenced.
CpuCoreCount int: The Minimum number of OCPUs to be made available for this Deployment.
DefinedTags map[string]string: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
FreeformTags map[string]string: A 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 pipeline. This option applies when retrieving a pipeline.
IsAutoScalingEnabled bool: Indicates if auto scaling is enabled for the Deployment's CPU core count.
LicenseModel string: The Oracle license model that applies to a Deployment.
LifecycleDetails string: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
LifecycleSubState string: Possible lifecycle substates when retrieving a pipeline.
Locks []GetPipelineLock: Locks associated with this resource.
MappingRules []GetPipelineMappingRule: Mapping for source/target schema/tables for the pipeline data replication.
PipelineDiagnosticDatas []GetPipelinePipelineDiagnosticData: Information regarding the pipeline diagnostic collection
PipelineId string
ProcessOptions []GetPipelineProcessOption: Required pipeline options to configure the replication process (Extract or Replicat).
RecipeType string: The type of the recipe
SourceConnectionDetails []GetPipelineSourceConnectionDetail: The source connection details for creating a pipeline.
State string: Lifecycle state of the pipeline.
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}}
TargetConnectionDetails []GetPipelineTargetConnectionDetail: The target connection details for creating a pipeline.
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeLastRecorded string: When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

compartmentId String: The OCID of the compartment being referenced.
cpuCoreCount Integer: The Minimum number of OCPUs to be made available for this Deployment.
definedTags Map<String,String>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Metadata about this specific object.
displayName String: An object's Display Name.
freeformTags Map<String,String>: A 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 pipeline. This option applies when retrieving a pipeline.
isAutoScalingEnabled Boolean: Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel String: The Oracle license model that applies to a Deployment.
lifecycleDetails String: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
lifecycleSubState String: Possible lifecycle substates when retrieving a pipeline.
locks List<GetPipelineLock>: Locks associated with this resource.
mappingRules List<GetPipelineMappingRule>: Mapping for source/target schema/tables for the pipeline data replication.
pipelineDiagnosticDatas List<GetPipelinePipelineDiagnosticData>: Information regarding the pipeline diagnostic collection
pipelineId String
processOptions List<GetPipelineProcessOption>: Required pipeline options to configure the replication process (Extract or Replicat).
recipeType String: The type of the recipe
sourceConnectionDetails List<GetPipelineSourceConnectionDetail>: The source connection details for creating a pipeline.
state String: Lifecycle state of the pipeline.
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}}
targetConnectionDetails List<GetPipelineTargetConnectionDetail>: The target connection details for creating a pipeline.
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeLastRecorded String: When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

compartmentId string: The OCID of the compartment being referenced.
cpuCoreCount number: The Minimum number of OCPUs to be made available for this Deployment.
definedTags {[key: string]: string}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: Metadata about this specific object.
displayName string: An object's Display Name.
freeformTags {[key: string]: string}: A 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 pipeline. This option applies when retrieving a pipeline.
isAutoScalingEnabled boolean: Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel string: The Oracle license model that applies to a Deployment.
lifecycleDetails string: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
lifecycleSubState string: Possible lifecycle substates when retrieving a pipeline.
locks GetPipelineLock[]: Locks associated with this resource.
mappingRules GetPipelineMappingRule[]: Mapping for source/target schema/tables for the pipeline data replication.
pipelineDiagnosticDatas GetPipelinePipelineDiagnosticData[]: Information regarding the pipeline diagnostic collection
pipelineId string
processOptions GetPipelineProcessOption[]: Required pipeline options to configure the replication process (Extract or Replicat).
recipeType string: The type of the recipe
sourceConnectionDetails GetPipelineSourceConnectionDetail[]: The source connection details for creating a pipeline.
state string: Lifecycle state of the pipeline.
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}}
targetConnectionDetails GetPipelineTargetConnectionDetail[]: The target connection details for creating a pipeline.
timeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeLastRecorded string: When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.
timeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

compartment_id str: The OCID of the compartment being referenced.
cpu_core_count int: The Minimum number of OCPUs to be made available for this Deployment.
defined_tags Mapping[str, str]: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: Metadata about this specific object.
display_name str: An object's Display Name.
freeform_tags Mapping[str, str]: A 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 pipeline. This option applies when retrieving a pipeline.
is_auto_scaling_enabled bool: Indicates if auto scaling is enabled for the Deployment's CPU core count.
license_model str: The Oracle license model that applies to a Deployment.
lifecycle_details str: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
lifecycle_sub_state str: Possible lifecycle substates when retrieving a pipeline.
locks Sequence[goldengate.GetPipelineLock]: Locks associated with this resource.
mapping_rules Sequence[goldengate.GetPipelineMappingRule]: Mapping for source/target schema/tables for the pipeline data replication.
pipeline_diagnostic_datas Sequence[goldengate.GetPipelinePipelineDiagnosticData]: Information regarding the pipeline diagnostic collection
pipeline_id str
process_options Sequence[goldengate.GetPipelineProcessOption]: Required pipeline options to configure the replication process (Extract or Replicat).
recipe_type str: The type of the recipe
source_connection_details Sequence[goldengate.GetPipelineSourceConnectionDetail]: The source connection details for creating a pipeline.
state str: Lifecycle state of the pipeline.
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}}
target_connection_details Sequence[goldengate.GetPipelineTargetConnectionDetail]: The target connection details for creating a pipeline.
time_created str: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_last_recorded str: When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.
time_updated str: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

compartmentId String: The OCID of the compartment being referenced.
cpuCoreCount Number: The Minimum number of OCPUs to be made available for this Deployment.
definedTags Map<String>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Metadata about this specific object.
displayName String: An object's Display Name.
freeformTags Map<String>: A 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 pipeline. This option applies when retrieving a pipeline.
isAutoScalingEnabled Boolean: Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel String: The Oracle license model that applies to a Deployment.
lifecycleDetails String: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
lifecycleSubState String: Possible lifecycle substates when retrieving a pipeline.
locks List<Property Map>: Locks associated with this resource.
mappingRules List<Property Map>: Mapping for source/target schema/tables for the pipeline data replication.
pipelineDiagnosticDatas List<Property Map>: Information regarding the pipeline diagnostic collection
pipelineId String
processOptions List<Property Map>: Required pipeline options to configure the replication process (Extract or Replicat).
recipeType String: The type of the recipe
sourceConnectionDetails List<Property Map>: The source connection details for creating a pipeline.
state String: Lifecycle state of the pipeline.
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}}
targetConnectionDetails List<Property Map>: The target connection details for creating a pipeline.
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeLastRecorded String: When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Supporting Types

GetPipelineLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
type String: Type of the lock.

GetPipelineMappingRule

MappingType string: Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
Source string: The source schema/table combination for replication to target.
Target string: The target schema/table combination for replication from the source.

MappingType string: Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
Source string: The source schema/table combination for replication to target.
Target string: The target schema/table combination for replication from the source.

mappingType String: Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
source String: The source schema/table combination for replication to target.
target String: The target schema/table combination for replication from the source.

mappingType string: Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
source string: The source schema/table combination for replication to target.
target string: The target schema/table combination for replication from the source.

mapping_type str: Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
source str: The source schema/table combination for replication to target.
target str: The target schema/table combination for replication from the source.

mappingType String: Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.
source String: The source schema/table combination for replication to target.
target String: The target schema/table combination for replication from the source.

GetPipelinePipelineDiagnosticData

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
DiagnosticState string: The state of the pipeline diagnostics collection.
Namespace string: Name of namespace that serves as a container for all of your buckets
Object string: Name of the diagnostic collected and uploaded to object storage
TimeLastCollected string: The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
DiagnosticState string: The state of the pipeline diagnostics collection.
Namespace string: Name of namespace that serves as a container for all of your buckets
Object string: Name of the diagnostic collected and uploaded to object storage
TimeLastCollected string: The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState String: The state of the pipeline diagnostics collection.
namespace String: Name of namespace that serves as a container for all of your buckets
object String: Name of the diagnostic collected and uploaded to object storage
timeLastCollected String: The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

bucket string: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState string: The state of the pipeline diagnostics collection.
namespace string: Name of namespace that serves as a container for all of your buckets
object string: Name of the diagnostic collected and uploaded to object storage
timeLastCollected string: The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

bucket str: Name of the bucket where the object is to be uploaded in the object storage
diagnostic_state str: The state of the pipeline diagnostics collection.
namespace str: Name of namespace that serves as a container for all of your buckets
object str: Name of the diagnostic collected and uploaded to object storage
time_last_collected str: The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState String: The state of the pipeline diagnostics collection.
namespace String: Name of namespace that serves as a container for all of your buckets
object String: Name of the diagnostic collected and uploaded to object storage
timeLastCollected String: The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339, such as 2024-07-25T21:10:29.600Z.

GetPipelineProcessOption

InitialDataLoads List<GetPipelineProcessOptionInitialDataLoad>: Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
ReplicateSchemaChanges List<GetPipelineProcessOptionReplicateSchemaChange>: Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
ShouldRestartOnFailure string: If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
StartUsingDefaultMapping string: If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option applies when creating or updating a pipeline.

InitialDataLoads []GetPipelineProcessOptionInitialDataLoad: Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
ReplicateSchemaChanges []GetPipelineProcessOptionReplicateSchemaChange: Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
ShouldRestartOnFailure string: If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
StartUsingDefaultMapping string: If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option applies when creating or updating a pipeline.

initialDataLoads List<GetPipelineProcessOptionInitialDataLoad>: Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
replicateSchemaChanges List<GetPipelineProcessOptionReplicateSchemaChange>: Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
shouldRestartOnFailure String: If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
startUsingDefaultMapping String: If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option applies when creating or updating a pipeline.

initialDataLoads GetPipelineProcessOptionInitialDataLoad[]: Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
replicateSchemaChanges GetPipelineProcessOptionReplicateSchemaChange[]: Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
shouldRestartOnFailure string: If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
startUsingDefaultMapping string: If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option applies when creating or updating a pipeline.

initial_data_loads Sequence[goldengate.GetPipelineProcessOptionInitialDataLoad]: Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
replicate_schema_changes Sequence[goldengate.GetPipelineProcessOptionReplicateSchemaChange]: Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
should_restart_on_failure str: If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
start_using_default_mapping str: If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option applies when creating or updating a pipeline.

initialDataLoads List<Property Map>: Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
replicateSchemaChanges List<Property Map>: Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
shouldRestartOnFailure String: If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
startUsingDefaultMapping String: If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option applies when creating or updating a pipeline.

GetPipelineProcessOptionInitialDataLoad

ActionOnExistingTable string: Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
IsInitialLoad string: If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

ActionOnExistingTable string: Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
IsInitialLoad string: If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

actionOnExistingTable String: Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
isInitialLoad String: If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

actionOnExistingTable string: Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
isInitialLoad string: If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

action_on_existing_table str: Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
is_initial_load str: If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

actionOnExistingTable String: Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
isInitialLoad String: If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

GetPipelineProcessOptionReplicateSchemaChange

ActionOnDdlError string: Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
ActionOnDmlError string: Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
CanReplicateSchemaChange string: If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.

ActionOnDdlError string: Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
ActionOnDmlError string: Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
CanReplicateSchemaChange string: If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.

actionOnDdlError String: Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
actionOnDmlError String: Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
canReplicateSchemaChange String: If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.

actionOnDdlError string: Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
actionOnDmlError string: Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
canReplicateSchemaChange string: If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.

action_on_ddl_error str: Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
action_on_dml_error str: Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
can_replicate_schema_change str: If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.

actionOnDdlError String: Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
actionOnDmlError String: Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
canReplicateSchemaChange String: If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.

GetPipelineSourceConnectionDetail

ConnectionId string: The OCID of the connection being referenced.

ConnectionId string: The OCID of the connection being referenced.

connectionId String: The OCID of the connection being referenced.

connectionId string: The OCID of the connection being referenced.

connection_id str: The OCID of the connection being referenced.

connectionId String: The OCID of the connection being referenced.

GetPipelineTargetConnectionDetail

ConnectionId string: The OCID of the connection being referenced.

ConnectionId string: The OCID of the connection being referenced.

connectionId String: The OCID of the connection being referenced.

connectionId string: The OCID of the connection being referenced.

connection_id str: The OCID of the connection being referenced.

connectionId String: The OCID of the connection being referenced.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

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

pulumi/pulumi-oci

oci.GoldenGate.getPipeline

On this page

On this page

Example Usage

Using getPipeline

getPipeline Result

Supporting Types

GetPipelineLock

GetPipelineMappingRule

GetPipelinePipelineDiagnosticData

GetPipelineProcessOption

GetPipelineProcessOptionInitialDataLoad

GetPipelineProcessOptionReplicateSchemaChange

GetPipelineSourceConnectionDetail

GetPipelineTargetConnectionDetail

Package Details

On this page

On this page