1. Packages
  2. Koyeb
  3. API Docs
  4. getService
koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb

koyeb.getService

Explore with Pulumi AI

koyeb logo
koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as koyeb from "@pulumi/koyeb";
    
    const my-service = koyeb.getService({
        slug: "my-app/my-service",
    });
    
    import pulumi
    import pulumi_koyeb as koyeb
    
    my_service = koyeb.get_service(slug="my-app/my-service")
    
    package main
    
    import (
    	"github.com/koyeb/pulumi-koyeb/sdk/go/koyeb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := koyeb.LookupService(ctx, &koyeb.LookupServiceArgs{
    			Slug: "my-app/my-service",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Koyeb = Pulumi.Koyeb;
    
    return await Deployment.RunAsync(() => 
    {
        var my_service = Koyeb.GetService.Invoke(new()
        {
            Slug = "my-app/my-service",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.koyeb.KoyebFunctions;
    import com.pulumi.koyeb.inputs.GetServiceArgs;
    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-service = KoyebFunctions.getService(GetServiceArgs.builder()
                .slug("my-app/my-service")
                .build());
    
        }
    }
    
    variables:
      my-service:
        fn::invoke:
          Function: koyeb:getService
          Arguments:
            slug: my-app/my-service
    

    Using getService

    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 getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
    function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(messages: Optional[str] = None,
                    slug: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetServiceResult
    def get_service_output(messages: Optional[pulumi.Input[str]] = None,
                    slug: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
    func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

    public static class GetService 
    {
        public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: koyeb:index/getService:getService
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Slug string
    The service slug composed of the app and service name, for instance my-app/my-service
    Messages string
    The status messages of the service
    Slug string
    The service slug composed of the app and service name, for instance my-app/my-service
    Messages string
    The status messages of the service
    slug String
    The service slug composed of the app and service name, for instance my-app/my-service
    messages String
    The status messages of the service
    slug string
    The service slug composed of the app and service name, for instance my-app/my-service
    messages string
    The status messages of the service
    slug str
    The service slug composed of the app and service name, for instance my-app/my-service
    messages str
    The status messages of the service
    slug String
    The service slug composed of the app and service name, for instance my-app/my-service
    messages String
    The status messages of the service

    getService Result

    The following output properties are available:

    ActiveDeployment string
    The service active deployment id
    AppId string
    The app id the service is assigned
    CreatedAt string
    The date and time of when the service was created
    Id string
    The id of the service
    LatestDeployment string
    The service latest deployment id
    Messages string
    The status messages of the service
    Name string
    The name of the service
    OrganizationId string
    The organization id owning the service
    PausedAt string
    The date and time of when the service was last updated
    ResumedAt string
    The date and time of when the service was last updated
    Slug string
    The service slug composed of the app and service name, for instance my-app/my-service
    Status string
    The status of the service
    TerminatedAt string
    The date and time of when the service was last updated
    UpdatedAt string
    The date and time of when the service was last updated
    Version string
    The version of the service
    ActiveDeployment string
    The service active deployment id
    AppId string
    The app id the service is assigned
    CreatedAt string
    The date and time of when the service was created
    Id string
    The id of the service
    LatestDeployment string
    The service latest deployment id
    Messages string
    The status messages of the service
    Name string
    The name of the service
    OrganizationId string
    The organization id owning the service
    PausedAt string
    The date and time of when the service was last updated
    ResumedAt string
    The date and time of when the service was last updated
    Slug string
    The service slug composed of the app and service name, for instance my-app/my-service
    Status string
    The status of the service
    TerminatedAt string
    The date and time of when the service was last updated
    UpdatedAt string
    The date and time of when the service was last updated
    Version string
    The version of the service
    activeDeployment String
    The service active deployment id
    appId String
    The app id the service is assigned
    createdAt String
    The date and time of when the service was created
    id String
    The id of the service
    latestDeployment String
    The service latest deployment id
    messages String
    The status messages of the service
    name String
    The name of the service
    organizationId String
    The organization id owning the service
    pausedAt String
    The date and time of when the service was last updated
    resumedAt String
    The date and time of when the service was last updated
    slug String
    The service slug composed of the app and service name, for instance my-app/my-service
    status String
    The status of the service
    terminatedAt String
    The date and time of when the service was last updated
    updatedAt String
    The date and time of when the service was last updated
    version String
    The version of the service
    activeDeployment string
    The service active deployment id
    appId string
    The app id the service is assigned
    createdAt string
    The date and time of when the service was created
    id string
    The id of the service
    latestDeployment string
    The service latest deployment id
    messages string
    The status messages of the service
    name string
    The name of the service
    organizationId string
    The organization id owning the service
    pausedAt string
    The date and time of when the service was last updated
    resumedAt string
    The date and time of when the service was last updated
    slug string
    The service slug composed of the app and service name, for instance my-app/my-service
    status string
    The status of the service
    terminatedAt string
    The date and time of when the service was last updated
    updatedAt string
    The date and time of when the service was last updated
    version string
    The version of the service
    active_deployment str
    The service active deployment id
    app_id str
    The app id the service is assigned
    created_at str
    The date and time of when the service was created
    id str
    The id of the service
    latest_deployment str
    The service latest deployment id
    messages str
    The status messages of the service
    name str
    The name of the service
    organization_id str
    The organization id owning the service
    paused_at str
    The date and time of when the service was last updated
    resumed_at str
    The date and time of when the service was last updated
    slug str
    The service slug composed of the app and service name, for instance my-app/my-service
    status str
    The status of the service
    terminated_at str
    The date and time of when the service was last updated
    updated_at str
    The date and time of when the service was last updated
    version str
    The version of the service
    activeDeployment String
    The service active deployment id
    appId String
    The app id the service is assigned
    createdAt String
    The date and time of when the service was created
    id String
    The id of the service
    latestDeployment String
    The service latest deployment id
    messages String
    The status messages of the service
    name String
    The name of the service
    organizationId String
    The organization id owning the service
    pausedAt String
    The date and time of when the service was last updated
    resumedAt String
    The date and time of when the service was last updated
    slug String
    The service slug composed of the app and service name, for instance my-app/my-service
    status String
    The status of the service
    terminatedAt String
    The date and time of when the service was last updated
    updatedAt String
    The date and time of when the service was last updated
    version String
    The version of the service

    Package Details

    Repository
    koyeb koyeb/pulumi-koyeb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the koyeb Terraform Provider.
    koyeb logo
    koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb