Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.GoldenGate.getRecipes

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

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

const testRecipes = oci.GoldenGate.getRecipes({
    compartmentId: compartmentId,
    displayName: recipeDisplayName,
    recipeType: recipeRecipeType,
});

import pulumi
import pulumi_oci as oci

test_recipes = oci.GoldenGate.get_recipes(compartment_id=compartment_id,
    display_name=recipe_display_name,
    recipe_type=recipe_recipe_type)

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.GetRecipes(ctx, &goldengate.GetRecipesArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(recipeDisplayName),
			RecipeType:    pulumi.StringRef(recipeRecipeType),
		}, 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 testRecipes = Oci.GoldenGate.GetRecipes.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = recipeDisplayName,
        RecipeType = recipeRecipeType,
    });

});

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.GetRecipesArgs;
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 testRecipes = GoldenGateFunctions.getRecipes(GetRecipesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(recipeDisplayName)
            .recipeType(recipeRecipeType)
            .build());

    }
}

variables:
  testRecipes:
    fn::invoke:
      function: oci:GoldenGate:getRecipes
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${recipeDisplayName}
        recipeType: ${recipeRecipeType}

Using getRecipes

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRecipes(args: GetRecipesArgs, opts?: InvokeOptions): Promise<GetRecipesResult>
function getRecipesOutput(args: GetRecipesOutputArgs, opts?: InvokeOptions): Output<GetRecipesResult>

def get_recipes(compartment_id: Optional[str] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_goldengate.GetRecipesFilter]] = None,
                recipe_type: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRecipesResult
def get_recipes_output(compartment_id: Optional[pulumi.Input[str]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_goldengate.GetRecipesFilterArgs]]]] = None,
                recipe_type: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRecipesResult]

func GetRecipes(ctx *Context, args *GetRecipesArgs, opts ...InvokeOption) (*GetRecipesResult, error)
func GetRecipesOutput(ctx *Context, args *GetRecipesOutputArgs, opts ...InvokeOption) GetRecipesResultOutput

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

public static class GetRecipes 
{
    public static Task<GetRecipesResult> InvokeAsync(GetRecipesArgs args, InvokeOptions? opts = null)
    public static Output<GetRecipesResult> Invoke(GetRecipesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRecipesResult> getRecipes(GetRecipesArgs args, InvokeOptions options)
public static Output<GetRecipesResult> getRecipes(GetRecipesArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
Filters List<GetRecipesFilter>
RecipeType string: The pipeline's recipe type. The default value is ZERO_ETL.

CompartmentId string: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
Filters []GetRecipesFilter
RecipeType string: The pipeline's recipe type. The default value is ZERO_ETL.

compartmentId String: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
filters List<GetRecipesFilter>
recipeType String: The pipeline's recipe type. The default value is ZERO_ETL.

compartmentId string: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
displayName string: A filter to return only the resources that match the entire 'displayName' given.
filters GetRecipesFilter[]
recipeType string: The pipeline's recipe type. The default value is ZERO_ETL.

compartment_id str: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
display_name str: A filter to return only the resources that match the entire 'displayName' given.
filters Sequence[goldengate.GetRecipesFilter]
recipe_type str: The pipeline's recipe type. The default value is ZERO_ETL.

compartmentId String: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
filters List<Property Map>
recipeType String: The pipeline's recipe type. The default value is ZERO_ETL.

getRecipes Result

The following output properties are available:

CompartmentId string
Id string: The provider-assigned unique ID for this managed resource.
RecipeSummaryCollections List<GetRecipesRecipeSummaryCollection>: The list of recipe_summary_collection.
DisplayName string: An object's Display Name.
Filters List<GetRecipesFilter>
RecipeType string: The type of the recipe

CompartmentId string
Id string: The provider-assigned unique ID for this managed resource.
RecipeSummaryCollections []GetRecipesRecipeSummaryCollection: The list of recipe_summary_collection.
DisplayName string: An object's Display Name.
Filters []GetRecipesFilter
RecipeType string: The type of the recipe

compartmentId String
id String: The provider-assigned unique ID for this managed resource.
recipeSummaryCollections List<GetRecipesRecipeSummaryCollection>: The list of recipe_summary_collection.
displayName String: An object's Display Name.
filters List<GetRecipesFilter>
recipeType String: The type of the recipe

compartmentId string
id string: The provider-assigned unique ID for this managed resource.
recipeSummaryCollections GetRecipesRecipeSummaryCollection[]: The list of recipe_summary_collection.
displayName string: An object's Display Name.
filters GetRecipesFilter[]
recipeType string: The type of the recipe

compartment_id str
id str: The provider-assigned unique ID for this managed resource.
recipe_summary_collections Sequence[goldengate.GetRecipesRecipeSummaryCollection]: The list of recipe_summary_collection.
display_name str: An object's Display Name.
filters Sequence[goldengate.GetRecipesFilter]
recipe_type str: The type of the recipe

compartmentId String
id String: The provider-assigned unique ID for this managed resource.
recipeSummaryCollections List<Property Map>: The list of recipe_summary_collection.
displayName String: An object's Display Name.
filters List<Property Map>
recipeType String: The type of the recipe

Supporting Types

GetRecipesFilter

Name string: An object's Display Name.
Values List<string>
Regex bool

Name string: An object's Display Name.
Values []string
Regex bool

name String: An object's Display Name.
values List<String>
regex Boolean

name string: An object's Display Name.
values string[]
regex boolean

name str: An object's Display Name.
values Sequence[str]
regex bool

name String: An object's Display Name.
values List<String>
regex Boolean

GetRecipesRecipeSummaryCollection

Items List<GetRecipesRecipeSummaryCollectionItem>: Array of Recipe Summary

Items []GetRecipesRecipeSummaryCollectionItem: Array of Recipe Summary

items List<GetRecipesRecipeSummaryCollectionItem>: Array of Recipe Summary

items GetRecipesRecipeSummaryCollectionItem[]: Array of Recipe Summary

items Sequence[goldengate.GetRecipesRecipeSummaryCollectionItem]: Array of Recipe Summary

items List<Property Map>: Array of Recipe Summary

GetRecipesRecipeSummaryCollectionItem

Description string: Metadata about this specific object.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
Name string: An object's Display Name.
RecipeType string: The pipeline's recipe type. The default value is ZERO_ETL.
SupportedSourceTechnologyTypes List<string>: Array of supported technology types for this recipe.
SupportedTargetTechnologyTypes List<string>: Array of supported technology types for this recipe.

Description string: Metadata about this specific object.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
Name string: An object's Display Name.
RecipeType string: The pipeline's recipe type. The default value is ZERO_ETL.
SupportedSourceTechnologyTypes []string: Array of supported technology types for this recipe.
SupportedTargetTechnologyTypes []string: Array of supported technology types for this recipe.

description String: Metadata about this specific object.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
name String: An object's Display Name.
recipeType String: The pipeline's recipe type. The default value is ZERO_ETL.
supportedSourceTechnologyTypes List<String>: Array of supported technology types for this recipe.
supportedTargetTechnologyTypes List<String>: Array of supported technology types for this recipe.

description string: Metadata about this specific object.
displayName string: A filter to return only the resources that match the entire 'displayName' given.
name string: An object's Display Name.
recipeType string: The pipeline's recipe type. The default value is ZERO_ETL.
supportedSourceTechnologyTypes string[]: Array of supported technology types for this recipe.
supportedTargetTechnologyTypes string[]: Array of supported technology types for this recipe.

description str: Metadata about this specific object.
display_name str: A filter to return only the resources that match the entire 'displayName' given.
name str: An object's Display Name.
recipe_type str: The pipeline's recipe type. The default value is ZERO_ETL.
supported_source_technology_types Sequence[str]: Array of supported technology types for this recipe.
supported_target_technology_types Sequence[str]: Array of supported technology types for this recipe.

description String: Metadata about this specific object.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
name String: An object's Display Name.
recipeType String: The pipeline's recipe type. The default value is ZERO_ETL.
supportedSourceTechnologyTypes List<String>: Array of supported technology types for this recipe.
supportedTargetTechnologyTypes List<String>: Array of supported technology types for this recipe.

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.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.GoldenGate.getRecipes

On this page

On this page

Example Usage

Using getRecipes

getRecipes Result

Supporting Types

GetRecipesFilter

GetRecipesRecipeSummaryCollection

GetRecipesRecipeSummaryCollectionItem

Package Details

On this page

On this page