1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. getUserProvidedService
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community

cloudfoundry.getUserProvidedService

Explore with Pulumi AI

cloudfoundry logo
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community

    Gets information on a Cloud Foundry user provided service (see user provided services).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudfoundry from "@pulumi/cloudfoundry";
    
    const my_instance = cloudfoundry.getUserProvidedService({
        name: "my-service-instance",
        space: "space-id",
    });
    
    import pulumi
    import pulumi_cloudfoundry as cloudfoundry
    
    my_instance = cloudfoundry.get_user_provided_service(name="my-service-instance",
        space="space-id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cloudfoundry/cloudfoundry"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudfoundry.LookupUserProvidedService(ctx, &cloudfoundry.LookupUserProvidedServiceArgs{
    			Name:  "my-service-instance",
    			Space: "space-id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudfoundry = Pulumi.Cloudfoundry;
    
    return await Deployment.RunAsync(() => 
    {
        var my_instance = Cloudfoundry.GetUserProvidedService.Invoke(new()
        {
            Name = "my-service-instance",
            Space = "space-id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudfoundry.CloudfoundryFunctions;
    import com.pulumi.cloudfoundry.inputs.GetUserProvidedServiceArgs;
    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 my-instance = CloudfoundryFunctions.getUserProvidedService(GetUserProvidedServiceArgs.builder()
                .name("my-service-instance")
                .space("space-id")
                .build());
    
        }
    }
    
    variables:
      my-instance:
        fn::invoke:
          function: cloudfoundry:getUserProvidedService
          arguments:
            name: my-service-instance
            space: space-id
    

    Using getUserProvidedService

    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 getUserProvidedService(args: GetUserProvidedServiceArgs, opts?: InvokeOptions): Promise<GetUserProvidedServiceResult>
    function getUserProvidedServiceOutput(args: GetUserProvidedServiceOutputArgs, opts?: InvokeOptions): Output<GetUserProvidedServiceResult>
    def get_user_provided_service(id: Optional[str] = None,
                                  name: Optional[str] = None,
                                  space: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetUserProvidedServiceResult
    def get_user_provided_service_output(id: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  space: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetUserProvidedServiceResult]
    func LookupUserProvidedService(ctx *Context, args *LookupUserProvidedServiceArgs, opts ...InvokeOption) (*LookupUserProvidedServiceResult, error)
    func LookupUserProvidedServiceOutput(ctx *Context, args *LookupUserProvidedServiceOutputArgs, opts ...InvokeOption) LookupUserProvidedServiceResultOutput

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

    public static class GetUserProvidedService 
    {
        public static Task<GetUserProvidedServiceResult> InvokeAsync(GetUserProvidedServiceArgs args, InvokeOptions? opts = null)
        public static Output<GetUserProvidedServiceResult> Invoke(GetUserProvidedServiceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserProvidedServiceResult> getUserProvidedService(GetUserProvidedServiceArgs args, InvokeOptions options)
    public static Output<GetUserProvidedServiceResult> getUserProvidedService(GetUserProvidedServiceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudfoundry:index/getUserProvidedService:getUserProvidedService
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the user provided service (NOT its guid).
    Space string
    The space GUID in which the user provided service is defined.
    Id string
    The GUID of the service instance.
    Name string
    The name of the user provided service (NOT its guid).
    Space string
    The space GUID in which the user provided service is defined.
    Id string
    The GUID of the service instance.
    name String
    The name of the user provided service (NOT its guid).
    space String
    The space GUID in which the user provided service is defined.
    id String
    The GUID of the service instance.
    name string
    The name of the user provided service (NOT its guid).
    space string
    The space GUID in which the user provided service is defined.
    id string
    The GUID of the service instance.
    name str
    The name of the user provided service (NOT its guid).
    space str
    The space GUID in which the user provided service is defined.
    id str
    The GUID of the service instance.
    name String
    The name of the user provided service (NOT its guid).
    space String
    The space GUID in which the user provided service is defined.
    id String
    The GUID of the service instance.

    getUserProvidedService Result

    The following output properties are available:

    Credentials Dictionary<string, string>
    A map of fields that was defined as input to the user provided service via the -p option in cf cli.
    Id string
    The GUID of the service instance.
    Name string
    The name of the service instance.
    RouteServiceUrl string
    The url of the route service that should proxy requests to an app (see route binding).
    Space string
    SyslogDrainUrl string
    The url of the syslog service to which app logs should be streamed.
    Tags List<string>
    Tags set during service instance creations.
    Credentials map[string]string
    A map of fields that was defined as input to the user provided service via the -p option in cf cli.
    Id string
    The GUID of the service instance.
    Name string
    The name of the service instance.
    RouteServiceUrl string
    The url of the route service that should proxy requests to an app (see route binding).
    Space string
    SyslogDrainUrl string
    The url of the syslog service to which app logs should be streamed.
    Tags []string
    Tags set during service instance creations.
    credentials Map<String,String>
    A map of fields that was defined as input to the user provided service via the -p option in cf cli.
    id String
    The GUID of the service instance.
    name String
    The name of the service instance.
    routeServiceUrl String
    The url of the route service that should proxy requests to an app (see route binding).
    space String
    syslogDrainUrl String
    The url of the syslog service to which app logs should be streamed.
    tags List<String>
    Tags set during service instance creations.
    credentials {[key: string]: string}
    A map of fields that was defined as input to the user provided service via the -p option in cf cli.
    id string
    The GUID of the service instance.
    name string
    The name of the service instance.
    routeServiceUrl string
    The url of the route service that should proxy requests to an app (see route binding).
    space string
    syslogDrainUrl string
    The url of the syslog service to which app logs should be streamed.
    tags string[]
    Tags set during service instance creations.
    credentials Mapping[str, str]
    A map of fields that was defined as input to the user provided service via the -p option in cf cli.
    id str
    The GUID of the service instance.
    name str
    The name of the service instance.
    route_service_url str
    The url of the route service that should proxy requests to an app (see route binding).
    space str
    syslog_drain_url str
    The url of the syslog service to which app logs should be streamed.
    tags Sequence[str]
    Tags set during service instance creations.
    credentials Map<String>
    A map of fields that was defined as input to the user provided service via the -p option in cf cli.
    id String
    The GUID of the service instance.
    name String
    The name of the service instance.
    routeServiceUrl String
    The url of the route service that should proxy requests to an app (see route binding).
    space String
    syslogDrainUrl String
    The url of the syslog service to which app logs should be streamed.
    tags List<String>
    Tags set during service instance creations.

    Package Details

    Repository
    cloudfoundry cloudfoundry-community/terraform-provider-cloudfoundry
    License
    Notes
    This Pulumi package is based on the cloudfoundry Terraform Provider.
    cloudfoundry logo
    cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community