Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GoldenGate
  5. Pipeline
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GoldenGate.Pipeline

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Pipeline resource in Oracle Cloud Infrastructure Golden Gate service.

    Creates a new Pipeline.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  testPipeline:
    type: oci:GoldenGate:Pipeline
    name: test_pipeline
    properties:
      compartmentId: ${compartmentId}
      displayName: ${pipelineDisplayName}
      licenseModel: ${pipelineLicenseModel}
      recipeType: ${pipelineRecipeType}
      sourceConnectionDetails:
        connectionId: ${testConnection.id}
      targetConnectionDetails:
        connectionId: ${testConnection.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${pipelineDescription}
      freeformTags:
        bar-key: value
      locks:
        - type: ${pipelineLocksType}
          message: ${pipelineLocksMessage}
          relatedResourceId: ${testResource.id}
          timeCreated: ${pipelineLocksTimeCreated}
      processOptions:
        initialDataLoad:
          isInitialLoad: ${pipelineProcessOptionsInitialDataLoadIsInitialLoad}
          actionOnExistingTable: ${pipelineProcessOptionsInitialDataLoadActionOnExistingTable}
        replicateSchemaChange:
          canReplicateSchemaChange: ${pipelineProcessOptionsReplicateSchemaChangeCanReplicateSchemaChange}
          actionOnDdlError: ${pipelineProcessOptionsReplicateSchemaChangeActionOnDdlError}
          actionOnDmlError: ${pipelineProcessOptionsReplicateSchemaChangeActionOnDmlError}
        shouldRestartOnFailure: ${pipelineProcessOptionsShouldRestartOnFailure}
        startUsingDefaultMapping: ${pipelineProcessOptionsStartUsingDefaultMapping}

    Create Pipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);
    @overload
def Pipeline(resource_name: str,
             args: PipelineArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             compartment_id: Optional[str] = None,
             display_name: Optional[str] = None,
             license_model: Optional[str] = None,
             recipe_type: Optional[str] = None,
             source_connection_details: Optional[PipelineSourceConnectionDetailsArgs] = None,
             target_connection_details: Optional[PipelineTargetConnectionDetailsArgs] = None,
             defined_tags: Optional[Mapping[str, str]] = None,
             description: Optional[str] = None,
             freeform_tags: Optional[Mapping[str, str]] = None,
             locks: Optional[Sequence[PipelineLockArgs]] = None,
             process_options: Optional[PipelineProcessOptionsArgs] = None)
    func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)

    type: oci:GoldenGate:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PipelineArgs
    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 PipelineArgs
    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 PipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ociPipelineResource = new Oci.GoldenGate.Pipeline("ociPipelineResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    LicenseModel = "string",
    RecipeType = "string",
    SourceConnectionDetails = new Oci.GoldenGate.Inputs.PipelineSourceConnectionDetailsArgs
    {
        ConnectionId = "string",
    },
    TargetConnectionDetails = new Oci.GoldenGate.Inputs.PipelineTargetConnectionDetailsArgs
    {
        ConnectionId = "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Locks = new[]
    {
        new Oci.GoldenGate.Inputs.PipelineLockArgs
        {
            Type = "string",
            Message = "string",
        },
    },
    ProcessOptions = new Oci.GoldenGate.Inputs.PipelineProcessOptionsArgs
    {
        InitialDataLoad = new Oci.GoldenGate.Inputs.PipelineProcessOptionsInitialDataLoadArgs
        {
            IsInitialLoad = "string",
            ActionOnExistingTable = "string",
        },
        ReplicateSchemaChange = new Oci.GoldenGate.Inputs.PipelineProcessOptionsReplicateSchemaChangeArgs
        {
            CanReplicateSchemaChange = "string",
            ActionOnDdlError = "string",
            ActionOnDmlError = "string",
        },
        ShouldRestartOnFailure = "string",
        StartUsingDefaultMapping = "string",
    },
});

    example, err := goldengate.NewPipeline(ctx, "ociPipelineResource", &goldengate.PipelineArgs{
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	LicenseModel:  pulumi.String("string"),
	RecipeType:    pulumi.String("string"),
	SourceConnectionDetails: &goldengate.PipelineSourceConnectionDetailsArgs{
		ConnectionId: pulumi.String("string"),
	},
	TargetConnectionDetails: &goldengate.PipelineTargetConnectionDetailsArgs{
		ConnectionId: pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Locks: goldengate.PipelineLockArray{
		&goldengate.PipelineLockArgs{
			Type:    pulumi.String("string"),
			Message: pulumi.String("string"),
		},
	},
	ProcessOptions: &goldengate.PipelineProcessOptionsArgs{
		InitialDataLoad: &goldengate.PipelineProcessOptionsInitialDataLoadArgs{
			IsInitialLoad:         pulumi.String("string"),
			ActionOnExistingTable: pulumi.String("string"),
		},
		ReplicateSchemaChange: &goldengate.PipelineProcessOptionsReplicateSchemaChangeArgs{
			CanReplicateSchemaChange: pulumi.String("string"),
			ActionOnDdlError:         pulumi.String("string"),
			ActionOnDmlError:         pulumi.String("string"),
		},
		ShouldRestartOnFailure:   pulumi.String("string"),
		StartUsingDefaultMapping: pulumi.String("string"),
	},
})

    var ociPipelineResource = new com.pulumi.oci.GoldenGate.Pipeline("ociPipelineResource", com.pulumi.oci.GoldenGate.PipelineArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .licenseModel("string")
    .recipeType("string")
    .sourceConnectionDetails(PipelineSourceConnectionDetailsArgs.builder()
        .connectionId("string")
        .build())
    .targetConnectionDetails(PipelineTargetConnectionDetailsArgs.builder()
        .connectionId("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .locks(PipelineLockArgs.builder()
        .type("string")
        .message("string")
        .build())
    .processOptions(PipelineProcessOptionsArgs.builder()
        .initialDataLoad(PipelineProcessOptionsInitialDataLoadArgs.builder()
            .isInitialLoad("string")
            .actionOnExistingTable("string")
            .build())
        .replicateSchemaChange(PipelineProcessOptionsReplicateSchemaChangeArgs.builder()
            .canReplicateSchemaChange("string")
            .actionOnDdlError("string")
            .actionOnDmlError("string")
            .build())
        .shouldRestartOnFailure("string")
        .startUsingDefaultMapping("string")
        .build())
    .build());

    oci_pipeline_resource = oci.golden_gate.Pipeline("ociPipelineResource",
    compartment_id="string",
    display_name="string",
    license_model="string",
    recipe_type="string",
    source_connection_details={
        "connection_id": "string",
    },
    target_connection_details={
        "connection_id": "string",
    },
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    locks=[{
        "type": "string",
        "message": "string",
    }],
    process_options={
        "initial_data_load": {
            "is_initial_load": "string",
            "action_on_existing_table": "string",
        },
        "replicate_schema_change": {
            "can_replicate_schema_change": "string",
            "action_on_ddl_error": "string",
            "action_on_dml_error": "string",
        },
        "should_restart_on_failure": "string",
        "start_using_default_mapping": "string",
    })

    const ociPipelineResource = new oci.goldengate.Pipeline("ociPipelineResource", {
    compartmentId: "string",
    displayName: "string",
    licenseModel: "string",
    recipeType: "string",
    sourceConnectionDetails: {
        connectionId: "string",
    },
    targetConnectionDetails: {
        connectionId: "string",
    },
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    locks: [{
        type: "string",
        message: "string",
    }],
    processOptions: {
        initialDataLoad: {
            isInitialLoad: "string",
            actionOnExistingTable: "string",
        },
        replicateSchemaChange: {
            canReplicateSchemaChange: "string",
            actionOnDdlError: "string",
            actionOnDmlError: "string",
        },
        shouldRestartOnFailure: "string",
        startUsingDefaultMapping: "string",
    },
});

    type: oci:GoldenGate:Pipeline
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    licenseModel: string
    locks:
        - message: string
          type: string
    processOptions:
        initialDataLoad:
            actionOnExistingTable: string
            isInitialLoad: string
        replicateSchemaChange:
            actionOnDdlError: string
            actionOnDmlError: string
            canReplicateSchemaChange: string
        shouldRestartOnFailure: string
        startUsingDefaultMapping: string
    recipeType: string
    sourceConnectionDetails:
        connectionId: string
    targetConnectionDetails:
        connectionId: string

    Pipeline Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Pipeline resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DisplayName string
    (Updatable) An object's Display Name.
    LicenseModel string
    (Updatable) The Oracle license model that applies to a Deployment.
    RecipeType string
    (Updatable) The type of the recipe
    SourceConnectionDetails PipelineSourceConnectionDetails
    The source connection details for creating a pipeline.
    TargetConnectionDetails PipelineTargetConnectionDetails
    The target connection details for creating a pipeline.
    DefinedTags Dictionary<string, string>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Locks List<PipelineLock>
    Locks associated with this resource.
    ProcessOptions PipelineProcessOptions
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DisplayName string
    (Updatable) An object's Display Name.
    LicenseModel string
    (Updatable) The Oracle license model that applies to a Deployment.
    RecipeType string
    (Updatable) The type of the recipe
    SourceConnectionDetails PipelineSourceConnectionDetailsArgs
    The source connection details for creating a pipeline.
    TargetConnectionDetails PipelineTargetConnectionDetailsArgs
    The target connection details for creating a pipeline.
    DefinedTags map[string]string
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Locks []PipelineLockArgs
    Locks associated with this resource.
    ProcessOptions PipelineProcessOptionsArgs
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    displayName String
    (Updatable) An object's Display Name.
    licenseModel String
    (Updatable) The Oracle license model that applies to a Deployment.
    recipeType String
    (Updatable) The type of the recipe
    sourceConnectionDetails PipelineSourceConnectionDetails
    The source connection details for creating a pipeline.
    targetConnectionDetails PipelineTargetConnectionDetails
    The target connection details for creating a pipeline.
    definedTags Map<String,String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks List<PipelineLock>
    Locks associated with this resource.
    processOptions PipelineProcessOptions
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    compartmentId string
    (Updatable) The OCID of the compartment being referenced.
    displayName string
    (Updatable) An object's Display Name.
    licenseModel string
    (Updatable) The Oracle license model that applies to a Deployment.
    recipeType string
    (Updatable) The type of the recipe
    sourceConnectionDetails PipelineSourceConnectionDetails
    The source connection details for creating a pipeline.
    targetConnectionDetails PipelineTargetConnectionDetails
    The target connection details for creating a pipeline.
    definedTags {[key: string]: string}
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Metadata about this specific object.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks PipelineLock[]
    Locks associated with this resource.
    processOptions PipelineProcessOptions
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    compartment_id str
    (Updatable) The OCID of the compartment being referenced.
    display_name str
    (Updatable) An object's Display Name.
    license_model str
    (Updatable) The Oracle license model that applies to a Deployment.
    recipe_type str
    (Updatable) The type of the recipe
    source_connection_details PipelineSourceConnectionDetailsArgs
    The source connection details for creating a pipeline.
    target_connection_details PipelineTargetConnectionDetailsArgs
    The target connection details for creating a pipeline.
    defined_tags Mapping[str, str]
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Metadata about this specific object.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks Sequence[PipelineLockArgs]
    Locks associated with this resource.
    process_options PipelineProcessOptionsArgs
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    displayName String
    (Updatable) An object's Display Name.
    licenseModel String
    (Updatable) The Oracle license model that applies to a Deployment.
    recipeType String
    (Updatable) The type of the recipe
    sourceConnectionDetails Property Map
    The source connection details for creating a pipeline.
    targetConnectionDetails Property Map
    The target connection details for creating a pipeline.
    definedTags Map<String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    locks List<Property Map>
    Locks associated with this resource.
    processOptions Property Map
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).

    Outputs

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

    CpuCoreCount int
    The Minimum number of OCPUs to be made available for this Deployment.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsAutoScalingEnabled bool
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    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.
    MappingRules List<PipelineMappingRule>
    Mapping for source/target schema/tables for the pipeline data replication.
    PipelineDiagnosticDatas List<PipelinePipelineDiagnosticData>
    Information regarding the pipeline diagnostic collection
    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}}
    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.
    CpuCoreCount int
    The Minimum number of OCPUs to be made available for this Deployment.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsAutoScalingEnabled bool
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    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.
    MappingRules []PipelineMappingRule
    Mapping for source/target schema/tables for the pipeline data replication.
    PipelineDiagnosticDatas []PipelinePipelineDiagnosticData
    Information regarding the pipeline diagnostic collection
    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}}
    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.
    cpuCoreCount Integer
    The Minimum number of OCPUs to be made available for this Deployment.
    id String
    The provider-assigned unique ID for this managed resource.
    isAutoScalingEnabled Boolean
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    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.
    mappingRules List<PipelineMappingRule>
    Mapping for source/target schema/tables for the pipeline data replication.
    pipelineDiagnosticDatas List<PipelinePipelineDiagnosticData>
    Information regarding the pipeline diagnostic collection
    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}}
    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.
    cpuCoreCount number
    The Minimum number of OCPUs to be made available for this Deployment.
    id string
    The provider-assigned unique ID for this managed resource.
    isAutoScalingEnabled boolean
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    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.
    mappingRules PipelineMappingRule[]
    Mapping for source/target schema/tables for the pipeline data replication.
    pipelineDiagnosticDatas PipelinePipelineDiagnosticData[]
    Information regarding the pipeline diagnostic collection
    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}}
    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.
    cpu_core_count int
    The Minimum number of OCPUs to be made available for this Deployment.
    id str
    The provider-assigned unique ID for this managed resource.
    is_auto_scaling_enabled bool
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    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.
    mapping_rules Sequence[PipelineMappingRule]
    Mapping for source/target schema/tables for the pipeline data replication.
    pipeline_diagnostic_datas Sequence[PipelinePipelineDiagnosticData]
    Information regarding the pipeline diagnostic collection
    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}}
    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.
    cpuCoreCount Number
    The Minimum number of OCPUs to be made available for this Deployment.
    id String
    The provider-assigned unique ID for this managed resource.
    isAutoScalingEnabled Boolean
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    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.
    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
    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}}
    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.

    Look up Existing Pipeline Resource

    Get an existing Pipeline 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?: PipelineState, opts?: CustomResourceOptions): Pipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        cpu_core_count: Optional[int] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_auto_scaling_enabled: Optional[bool] = None,
        license_model: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        lifecycle_sub_state: Optional[str] = None,
        locks: Optional[Sequence[PipelineLockArgs]] = None,
        mapping_rules: Optional[Sequence[PipelineMappingRuleArgs]] = None,
        pipeline_diagnostic_datas: Optional[Sequence[PipelinePipelineDiagnosticDataArgs]] = None,
        process_options: Optional[PipelineProcessOptionsArgs] = None,
        recipe_type: Optional[str] = None,
        source_connection_details: Optional[PipelineSourceConnectionDetailsArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        target_connection_details: Optional[PipelineTargetConnectionDetailsArgs] = None,
        time_created: Optional[str] = None,
        time_last_recorded: Optional[str] = None,
        time_updated: Optional[str] = None) -> Pipeline
    func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)
    public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)
    public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)
    resources:  _:    type: oci:GoldenGate:Pipeline    get:      id: ${id}
    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 being referenced.
    CpuCoreCount int
    The Minimum number of OCPUs to be made available for this Deployment.
    DefinedTags Dictionary<string, string>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    DisplayName string
    (Updatable) An object's Display Name.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsAutoScalingEnabled bool
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    LicenseModel string
    (Updatable) 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<PipelineLock>
    Locks associated with this resource.
    MappingRules List<PipelineMappingRule>
    Mapping for source/target schema/tables for the pipeline data replication.
    PipelineDiagnosticDatas List<PipelinePipelineDiagnosticData>
    Information regarding the pipeline diagnostic collection
    ProcessOptions PipelineProcessOptions
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    RecipeType string
    (Updatable) The type of the recipe
    SourceConnectionDetails PipelineSourceConnectionDetails
    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 PipelineTargetConnectionDetails
    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
    (Updatable) 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
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    DisplayName string
    (Updatable) An object's Display Name.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsAutoScalingEnabled bool
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    LicenseModel string
    (Updatable) 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 []PipelineLockArgs
    Locks associated with this resource.
    MappingRules []PipelineMappingRuleArgs
    Mapping for source/target schema/tables for the pipeline data replication.
    PipelineDiagnosticDatas []PipelinePipelineDiagnosticDataArgs
    Information regarding the pipeline diagnostic collection
    ProcessOptions PipelineProcessOptionsArgs
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    RecipeType string
    (Updatable) The type of the recipe
    SourceConnectionDetails PipelineSourceConnectionDetailsArgs
    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 PipelineTargetConnectionDetailsArgs
    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
    (Updatable) 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>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    displayName String
    (Updatable) An object's Display Name.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isAutoScalingEnabled Boolean
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    licenseModel String
    (Updatable) 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<PipelineLock>
    Locks associated with this resource.
    mappingRules List<PipelineMappingRule>
    Mapping for source/target schema/tables for the pipeline data replication.
    pipelineDiagnosticDatas List<PipelinePipelineDiagnosticData>
    Information regarding the pipeline diagnostic collection
    processOptions PipelineProcessOptions
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    recipeType String
    (Updatable) The type of the recipe
    sourceConnectionDetails PipelineSourceConnectionDetails
    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 PipelineTargetConnectionDetails
    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
    (Updatable) 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}
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Metadata about this specific object.
    displayName string
    (Updatable) An object's Display Name.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isAutoScalingEnabled boolean
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    licenseModel string
    (Updatable) 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 PipelineLock[]
    Locks associated with this resource.
    mappingRules PipelineMappingRule[]
    Mapping for source/target schema/tables for the pipeline data replication.
    pipelineDiagnosticDatas PipelinePipelineDiagnosticData[]
    Information regarding the pipeline diagnostic collection
    processOptions PipelineProcessOptions
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    recipeType string
    (Updatable) The type of the recipe
    sourceConnectionDetails PipelineSourceConnectionDetails
    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 PipelineTargetConnectionDetails
    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
    (Updatable) 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]
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Metadata about this specific object.
    display_name str
    (Updatable) An object's Display Name.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_auto_scaling_enabled bool
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    license_model str
    (Updatable) 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[PipelineLockArgs]
    Locks associated with this resource.
    mapping_rules Sequence[PipelineMappingRuleArgs]
    Mapping for source/target schema/tables for the pipeline data replication.
    pipeline_diagnostic_datas Sequence[PipelinePipelineDiagnosticDataArgs]
    Information regarding the pipeline diagnostic collection
    process_options PipelineProcessOptionsArgs
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    recipe_type str
    (Updatable) The type of the recipe
    source_connection_details PipelineSourceConnectionDetailsArgs
    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 PipelineTargetConnectionDetailsArgs
    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
    (Updatable) The OCID of the compartment being referenced.
    cpuCoreCount Number
    The Minimum number of OCPUs to be made available for this Deployment.
    definedTags Map<String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    displayName String
    (Updatable) An object's Display Name.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isAutoScalingEnabled Boolean
    Indicates if auto scaling is enabled for the Deployment's CPU core count.
    licenseModel String
    (Updatable) 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
    processOptions Property Map
    (Updatable) Required pipeline options to configure the replication process (Extract or Replicat).
    recipeType String
    (Updatable) The type of the recipe
    sourceConnectionDetails 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 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

    PipelineLock, PipelineLockArgs

    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 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 str
    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 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.

    PipelineMappingRule, PipelineMappingRuleArgs

    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.

    PipelinePipelineDiagnosticData, PipelinePipelineDiagnosticDataArgs

    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.

    PipelineProcessOptions, PipelineProcessOptionsArgs

    InitialDataLoad PipelineProcessOptionsInitialDataLoad
    (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    ReplicateSchemaChange PipelineProcessOptionsReplicateSchemaChange
    (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    ShouldRestartOnFailure string
    (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
    StartUsingDefaultMapping string
    (Updatable) 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.
    InitialDataLoad PipelineProcessOptionsInitialDataLoad
    (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    ReplicateSchemaChange PipelineProcessOptionsReplicateSchemaChange
    (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    ShouldRestartOnFailure string
    (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
    StartUsingDefaultMapping string
    (Updatable) 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.
    initialDataLoad PipelineProcessOptionsInitialDataLoad
    (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    replicateSchemaChange PipelineProcessOptionsReplicateSchemaChange
    (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    shouldRestartOnFailure String
    (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
    startUsingDefaultMapping String
    (Updatable) 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.
    initialDataLoad PipelineProcessOptionsInitialDataLoad
    (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    replicateSchemaChange PipelineProcessOptionsReplicateSchemaChange
    (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    shouldRestartOnFailure string
    (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
    startUsingDefaultMapping string
    (Updatable) 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_load PipelineProcessOptionsInitialDataLoad
    (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    replicate_schema_change PipelineProcessOptionsReplicateSchemaChange
    (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    should_restart_on_failure str
    (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
    start_using_default_mapping str
    (Updatable) 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.
    initialDataLoad Property Map
    (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    replicateSchemaChange Property Map
    (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
    shouldRestartOnFailure String
    (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.
    startUsingDefaultMapping String
    (Updatable) 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.

    PipelineProcessOptionsInitialDataLoad, PipelineProcessOptionsInitialDataLoadArgs

    IsInitialLoad string
    (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
    ActionOnExistingTable string
    (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
    IsInitialLoad string
    (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
    ActionOnExistingTable string
    (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
    isInitialLoad String
    (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
    actionOnExistingTable String
    (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
    isInitialLoad string
    (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
    actionOnExistingTable string
    (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
    is_initial_load str
    (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
    action_on_existing_table str
    (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.
    isInitialLoad String
    (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.
    actionOnExistingTable String
    (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.

    PipelineProcessOptionsReplicateSchemaChange, PipelineProcessOptionsReplicateSchemaChangeArgs

    CanReplicateSchemaChange string
    (Updatable) 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
    (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    ActionOnDmlError string
    (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    CanReplicateSchemaChange string
    (Updatable) 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
    (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    ActionOnDmlError string
    (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    canReplicateSchemaChange String
    (Updatable) 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
    (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    actionOnDmlError String
    (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    canReplicateSchemaChange string
    (Updatable) 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
    (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    actionOnDmlError string
    (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    can_replicate_schema_change str
    (Updatable) 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
    (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    action_on_dml_error str
    (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    canReplicateSchemaChange String
    (Updatable) 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
    (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true
    actionOnDmlError String
    (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true

    PipelineSourceConnectionDetails, PipelineSourceConnectionDetailsArgs

    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.

    PipelineTargetConnectionDetails, PipelineTargetConnectionDetailsArgs

    ConnectionId string

    The OCID of the connection being referenced.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    ConnectionId string

    The OCID of the connection being referenced.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    connectionId String

    The OCID of the connection being referenced.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    connectionId string

    The OCID of the connection being referenced.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    connection_id str

    The OCID of the connection being referenced.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    connectionId String

    The OCID of the connection being referenced.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

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

    $ pulumi import oci:GoldenGate/pipeline:Pipeline test_pipeline "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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