getService

Koyeb v0.1.11, Dec 9 24

Viewing docs for Koyeb v0.1.11
published on Monday, Dec 9, 2024 by Koyeb

Schema (JSON)

koyeb/pulumi-koyeb

Viewing docs for Koyeb v0.1.11
published on Monday, Dec 9, 2024 by Koyeb

Schema (JSON)

koyeb/pulumi-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)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

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
Definitions List<GetServiceDefinition>: The service deployment definition
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
Definitions []GetServiceDefinition: The service deployment definition
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
definitions List<GetServiceDefinition>: The service deployment definition
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
definitions GetServiceDefinition[]: The service deployment definition
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
definitions Sequence[GetServiceDefinition]: The service deployment definition
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
definitions List<Property Map>: The service deployment definition
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

Supporting Types

GetServiceDefinition

InstanceTypes List<GetServiceDefinitionInstanceType>
Name string: The service name
Regions List<string>: The service deployment regions to deploy to
Scalings List<GetServiceDefinitionScaling>
Docker GetServiceDefinitionDocker
Envs List<GetServiceDefinitionEnv>
Git GetServiceDefinitionGit
HealthChecks List<GetServiceDefinitionHealthCheck>
Ports List<GetServiceDefinitionPort>
Routes List<GetServiceDefinitionRoute>
SkipCache bool: If set to true, the service will be deployed without using the cache
Type string: The service type, either WEB or WORKER (default WEB)
Volumes List<GetServiceDefinitionVolume>: The volumes to attach and mount to the service

InstanceTypes []GetServiceDefinitionInstanceType
Name string: The service name
Regions []string: The service deployment regions to deploy to
Scalings []GetServiceDefinitionScaling
Docker GetServiceDefinitionDocker
Envs []GetServiceDefinitionEnv
Git GetServiceDefinitionGit
HealthChecks []GetServiceDefinitionHealthCheck
Ports []GetServiceDefinitionPort
Routes []GetServiceDefinitionRoute
SkipCache bool: If set to true, the service will be deployed without using the cache
Type string: The service type, either WEB or WORKER (default WEB)
Volumes []GetServiceDefinitionVolume: The volumes to attach and mount to the service

instanceTypes List<GetServiceDefinitionInstanceType>
name String: The service name
regions List<String>: The service deployment regions to deploy to
scalings List<GetServiceDefinitionScaling>
docker GetServiceDefinitionDocker
envs List<GetServiceDefinitionEnv>
git GetServiceDefinitionGit
healthChecks List<GetServiceDefinitionHealthCheck>
ports List<GetServiceDefinitionPort>
routes List<GetServiceDefinitionRoute>
skipCache Boolean: If set to true, the service will be deployed without using the cache
type String: The service type, either WEB or WORKER (default WEB)
volumes List<GetServiceDefinitionVolume>: The volumes to attach and mount to the service

instanceTypes GetServiceDefinitionInstanceType[]
name string: The service name
regions string[]: The service deployment regions to deploy to
scalings GetServiceDefinitionScaling[]
docker GetServiceDefinitionDocker
envs GetServiceDefinitionEnv[]
git GetServiceDefinitionGit
healthChecks GetServiceDefinitionHealthCheck[]
ports GetServiceDefinitionPort[]
routes GetServiceDefinitionRoute[]
skipCache boolean: If set to true, the service will be deployed without using the cache
type string: The service type, either WEB or WORKER (default WEB)
volumes GetServiceDefinitionVolume[]: The volumes to attach and mount to the service

instance_types Sequence[GetServiceDefinitionInstanceType]
name str: The service name
regions Sequence[str]: The service deployment regions to deploy to
scalings Sequence[GetServiceDefinitionScaling]
docker GetServiceDefinitionDocker
envs Sequence[GetServiceDefinitionEnv]
git GetServiceDefinitionGit
health_checks Sequence[GetServiceDefinitionHealthCheck]
ports Sequence[GetServiceDefinitionPort]
routes Sequence[GetServiceDefinitionRoute]
skip_cache bool: If set to true, the service will be deployed without using the cache
type str: The service type, either WEB or WORKER (default WEB)
volumes Sequence[GetServiceDefinitionVolume]: The volumes to attach and mount to the service

instanceTypes List<Property Map>
name String: The service name
regions List<String>: The service deployment regions to deploy to
scalings List<Property Map>
docker Property Map
envs List<Property Map>
git Property Map
healthChecks List<Property Map>
ports List<Property Map>
routes List<Property Map>
skipCache Boolean: If set to true, the service will be deployed without using the cache
type String: The service type, either WEB or WORKER (default WEB)
volumes List<Property Map>: The volumes to attach and mount to the service

GetServiceDefinitionDocker

Image string: The Docker image to use to support your service
Args List<string>: The Docker args to use
Command string: The Docker command to use
Entrypoints List<string>: The Docker entrypoint to use
ImageRegistrySecret string: The Koyeb secret containing the container registry credentials
Privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.

Image string: The Docker image to use to support your service
Args []string: The Docker args to use
Command string: The Docker command to use
Entrypoints []string: The Docker entrypoint to use
ImageRegistrySecret string: The Koyeb secret containing the container registry credentials
Privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.

image String: The Docker image to use to support your service
args List<String>: The Docker args to use
command String: The Docker command to use
entrypoints List<String>: The Docker entrypoint to use
imageRegistrySecret String: The Koyeb secret containing the container registry credentials
privileged Boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.

image string: The Docker image to use to support your service
args string[]: The Docker args to use
command string: The Docker command to use
entrypoints string[]: The Docker entrypoint to use
imageRegistrySecret string: The Koyeb secret containing the container registry credentials
privileged boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.

image str: The Docker image to use to support your service
args Sequence[str]: The Docker args to use
command str: The Docker command to use
entrypoints Sequence[str]: The Docker entrypoint to use
image_registry_secret str: The Koyeb secret containing the container registry credentials
privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.

image String: The Docker image to use to support your service
args List<String>: The Docker args to use
command String: The Docker command to use
entrypoints List<String>: The Docker entrypoint to use
imageRegistrySecret String: The Koyeb secret containing the container registry credentials
privileged Boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.

GetServiceDefinitionEnv

Key string: The name of the environment variable
Scopes List<string>: The regions the environment variable needs to be exposed
Secret string: The secret name to use as the value of the environment variable
Value string: The value of the environment variable

Key string: The name of the environment variable
Scopes []string: The regions the environment variable needs to be exposed
Secret string: The secret name to use as the value of the environment variable
Value string: The value of the environment variable

key String: The name of the environment variable
scopes List<String>: The regions the environment variable needs to be exposed
secret String: The secret name to use as the value of the environment variable
value String: The value of the environment variable

key string: The name of the environment variable
scopes string[]: The regions the environment variable needs to be exposed
secret string: The secret name to use as the value of the environment variable
value string: The value of the environment variable

key str: The name of the environment variable
scopes Sequence[str]: The regions the environment variable needs to be exposed
secret str: The secret name to use as the value of the environment variable
value str: The value of the environment variable

key String: The name of the environment variable
scopes List<String>: The regions the environment variable needs to be exposed
secret String: The secret name to use as the value of the environment variable
value String: The value of the environment variable

GetServiceDefinitionGit

Branch string: The GitHub branch to deploy
Repository string: The GitHub repository to deploy
Buildpack GetServiceDefinitionGitBuildpack
Dockerfile GetServiceDefinitionGitDockerfile
NoDeployOnPush bool: If set to true, no Koyeb deployments will be triggered when changes are pushed to the GitHub repository branch
Workdir string: The directory where your source code is located. If not set, the work directory defaults to the root of the repository.

Branch string: The GitHub branch to deploy
Repository string: The GitHub repository to deploy
Buildpack GetServiceDefinitionGitBuildpack
Dockerfile GetServiceDefinitionGitDockerfile
NoDeployOnPush bool: If set to true, no Koyeb deployments will be triggered when changes are pushed to the GitHub repository branch
Workdir string: The directory where your source code is located. If not set, the work directory defaults to the root of the repository.

branch String: The GitHub branch to deploy
repository String: The GitHub repository to deploy
buildpack GetServiceDefinitionGitBuildpack
dockerfile GetServiceDefinitionGitDockerfile
noDeployOnPush Boolean: If set to true, no Koyeb deployments will be triggered when changes are pushed to the GitHub repository branch
workdir String: The directory where your source code is located. If not set, the work directory defaults to the root of the repository.

branch string: The GitHub branch to deploy
repository string: The GitHub repository to deploy
buildpack GetServiceDefinitionGitBuildpack
dockerfile GetServiceDefinitionGitDockerfile
noDeployOnPush boolean: If set to true, no Koyeb deployments will be triggered when changes are pushed to the GitHub repository branch
workdir string: The directory where your source code is located. If not set, the work directory defaults to the root of the repository.

branch str: The GitHub branch to deploy
repository str: The GitHub repository to deploy
buildpack GetServiceDefinitionGitBuildpack
dockerfile GetServiceDefinitionGitDockerfile
no_deploy_on_push bool: If set to true, no Koyeb deployments will be triggered when changes are pushed to the GitHub repository branch
workdir str: The directory where your source code is located. If not set, the work directory defaults to the root of the repository.

branch String: The GitHub branch to deploy
repository String: The GitHub repository to deploy
buildpack Property Map
dockerfile Property Map
noDeployOnPush Boolean: If set to true, no Koyeb deployments will be triggered when changes are pushed to the GitHub repository branch
workdir String: The directory where your source code is located. If not set, the work directory defaults to the root of the repository.

GetServiceDefinitionGitBuildpack

BuildCommand string: The command to build your application during the build phase. If your application does not require a build command, leave this field empty
Privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
RunCommand string: The command to run your application once the built is completed

BuildCommand string: The command to build your application during the build phase. If your application does not require a build command, leave this field empty
Privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
RunCommand string: The command to run your application once the built is completed

buildCommand String: The command to build your application during the build phase. If your application does not require a build command, leave this field empty
privileged Boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
runCommand String: The command to run your application once the built is completed

buildCommand string: The command to build your application during the build phase. If your application does not require a build command, leave this field empty
privileged boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
runCommand string: The command to run your application once the built is completed

build_command str: The command to build your application during the build phase. If your application does not require a build command, leave this field empty
privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
run_command str: The command to run your application once the built is completed

buildCommand String: The command to build your application during the build phase. If your application does not require a build command, leave this field empty
privileged Boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
runCommand String: The command to run your application once the built is completed

GetServiceDefinitionGitDockerfile

Args List<string>: The arguments to pass to the Docker command
Command string: Override the command to execute on the container
Dockerfile string: The location of your Dockerfile relative to the work directory. If not set, the work directory defaults to the root of the repository.
Entrypoints List<string>: Override the default entrypoint to execute on the container
Privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
Target string: Target build stage: If your Dockerfile contains multi-stage builds, you can choose the target stage to build and deploy by entering its name

Args []string: The arguments to pass to the Docker command
Command string: Override the command to execute on the container
Dockerfile string: The location of your Dockerfile relative to the work directory. If not set, the work directory defaults to the root of the repository.
Entrypoints []string: Override the default entrypoint to execute on the container
Privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
Target string: Target build stage: If your Dockerfile contains multi-stage builds, you can choose the target stage to build and deploy by entering its name

args List<String>: The arguments to pass to the Docker command
command String: Override the command to execute on the container
dockerfile String: The location of your Dockerfile relative to the work directory. If not set, the work directory defaults to the root of the repository.
entrypoints List<String>: Override the default entrypoint to execute on the container
privileged Boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
target String: Target build stage: If your Dockerfile contains multi-stage builds, you can choose the target stage to build and deploy by entering its name

args string[]: The arguments to pass to the Docker command
command string: Override the command to execute on the container
dockerfile string: The location of your Dockerfile relative to the work directory. If not set, the work directory defaults to the root of the repository.
entrypoints string[]: Override the default entrypoint to execute on the container
privileged boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
target string: Target build stage: If your Dockerfile contains multi-stage builds, you can choose the target stage to build and deploy by entering its name

args Sequence[str]: The arguments to pass to the Docker command
command str: Override the command to execute on the container
dockerfile str: The location of your Dockerfile relative to the work directory. If not set, the work directory defaults to the root of the repository.
entrypoints Sequence[str]: Override the default entrypoint to execute on the container
privileged bool: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
target str: Target build stage: If your Dockerfile contains multi-stage builds, you can choose the target stage to build and deploy by entering its name

args List<String>: The arguments to pass to the Docker command
command String: Override the command to execute on the container
dockerfile String: The location of your Dockerfile relative to the work directory. If not set, the work directory defaults to the root of the repository.
entrypoints List<String>: Override the default entrypoint to execute on the container
privileged Boolean: When enabled, the service container will run in privileged mode. This advanced feature is useful to get advanced system privileges.
target String: Target build stage: If your Dockerfile contains multi-stage builds, you can choose the target stage to build and deploy by entering its name

GetServiceDefinitionHealthCheck

GracePeriod int: The period in seconds to wait for the instance to become healthy, default is 5s
Http GetServiceDefinitionHealthCheckHttp
Interval int: The period in seconds between two health checks, default is 60s
RestartLimit int: The number of consecutive failures before attempting to restart the service, default is 3
Tcp GetServiceDefinitionHealthCheckTcp
Timeout int: The maximum time to wait in seconds before considering the check as a failure, default is 5s

GracePeriod int: The period in seconds to wait for the instance to become healthy, default is 5s
Http GetServiceDefinitionHealthCheckHttp
Interval int: The period in seconds between two health checks, default is 60s
RestartLimit int: The number of consecutive failures before attempting to restart the service, default is 3
Tcp GetServiceDefinitionHealthCheckTcp
Timeout int: The maximum time to wait in seconds before considering the check as a failure, default is 5s

gracePeriod Integer: The period in seconds to wait for the instance to become healthy, default is 5s
http GetServiceDefinitionHealthCheckHttp
interval Integer: The period in seconds between two health checks, default is 60s
restartLimit Integer: The number of consecutive failures before attempting to restart the service, default is 3
tcp GetServiceDefinitionHealthCheckTcp
timeout Integer: The maximum time to wait in seconds before considering the check as a failure, default is 5s

gracePeriod number: The period in seconds to wait for the instance to become healthy, default is 5s
http GetServiceDefinitionHealthCheckHttp
interval number: The period in seconds between two health checks, default is 60s
restartLimit number: The number of consecutive failures before attempting to restart the service, default is 3
tcp GetServiceDefinitionHealthCheckTcp
timeout number: The maximum time to wait in seconds before considering the check as a failure, default is 5s

grace_period int: The period in seconds to wait for the instance to become healthy, default is 5s
http GetServiceDefinitionHealthCheckHttp
interval int: The period in seconds between two health checks, default is 60s
restart_limit int: The number of consecutive failures before attempting to restart the service, default is 3
tcp GetServiceDefinitionHealthCheckTcp
timeout int: The maximum time to wait in seconds before considering the check as a failure, default is 5s

gracePeriod Number: The period in seconds to wait for the instance to become healthy, default is 5s
http Property Map
interval Number: The period in seconds between two health checks, default is 60s
restartLimit Number: The number of consecutive failures before attempting to restart the service, default is 3
tcp Property Map
timeout Number: The maximum time to wait in seconds before considering the check as a failure, default is 5s

GetServiceDefinitionHealthCheckHttp

Path string: The path to use to perform the HTTP health check
Port int: The port to use to perform the health check
Headers List<GetServiceDefinitionHealthCheckHttpHeader>
Method string: An optional HTTP method to use to perform the health check, default is GET

Path string: The path to use to perform the HTTP health check
Port int: The port to use to perform the health check
Headers []GetServiceDefinitionHealthCheckHttpHeader
Method string: An optional HTTP method to use to perform the health check, default is GET

path String: The path to use to perform the HTTP health check
port Integer: The port to use to perform the health check
headers List<GetServiceDefinitionHealthCheckHttpHeader>
method String: An optional HTTP method to use to perform the health check, default is GET

path string: The path to use to perform the HTTP health check
port number: The port to use to perform the health check
headers GetServiceDefinitionHealthCheckHttpHeader[]
method string: An optional HTTP method to use to perform the health check, default is GET

path str: The path to use to perform the HTTP health check
port int: The port to use to perform the health check
headers Sequence[GetServiceDefinitionHealthCheckHttpHeader]
method str: An optional HTTP method to use to perform the health check, default is GET

path String: The path to use to perform the HTTP health check
port Number: The port to use to perform the health check
headers List<Property Map>
method String: An optional HTTP method to use to perform the health check, default is GET

GetServiceDefinitionHealthCheckHttpHeader

Key string: The name of the header
Value string: The value of the header

Key string: The name of the header
Value string: The value of the header

key String: The name of the header
value String: The value of the header

key string: The name of the header
value string: The value of the header

key str: The name of the header
value str: The value of the header

key String: The name of the header
value String: The value of the header

GetServiceDefinitionHealthCheckTcp

Port int: The port to use to perform the health check

Port int: The port to use to perform the health check

port Integer: The port to use to perform the health check

port number: The port to use to perform the health check

port int: The port to use to perform the health check

port Number: The port to use to perform the health check

GetServiceDefinitionInstanceType

Scopes List<string>: The regions to use the instance type
Type string: The instance type to use to support your service

Scopes []string: The regions to use the instance type
Type string: The instance type to use to support your service

scopes List<String>: The regions to use the instance type
type String: The instance type to use to support your service

scopes string[]: The regions to use the instance type
type string: The instance type to use to support your service

scopes Sequence[str]: The regions to use the instance type
type str: The instance type to use to support your service

scopes List<String>: The regions to use the instance type
type String: The instance type to use to support your service

GetServiceDefinitionPort

Port int: The internal port on which this service's run command will listen
Protocol string: The protocol used by your service

Port int: The internal port on which this service's run command will listen
Protocol string: The protocol used by your service

port Integer: The internal port on which this service's run command will listen
protocol String: The protocol used by your service

port number: The internal port on which this service's run command will listen
protocol string: The protocol used by your service

port int: The internal port on which this service's run command will listen
protocol str: The protocol used by your service

port Number: The internal port on which this service's run command will listen
protocol String: The protocol used by your service

GetServiceDefinitionRoute

Path string: Path specifies a route by HTTP path prefix. Paths must start with / and must be unique within the app
Port int: The internal port on which this service's run command will listen

Path string: Path specifies a route by HTTP path prefix. Paths must start with / and must be unique within the app
Port int: The internal port on which this service's run command will listen

path String: Path specifies a route by HTTP path prefix. Paths must start with / and must be unique within the app
port Integer: The internal port on which this service's run command will listen

path string: Path specifies a route by HTTP path prefix. Paths must start with / and must be unique within the app
port number: The internal port on which this service's run command will listen

path str: Path specifies a route by HTTP path prefix. Paths must start with / and must be unique within the app
port int: The internal port on which this service's run command will listen

path String: Path specifies a route by HTTP path prefix. Paths must start with / and must be unique within the app
port Number: The internal port on which this service's run command will listen

GetServiceDefinitionScaling

Scopes List<string>: The regions to apply the scaling configuration
Max int: The maximum number of instance to use to support your service
Min int: The minimal number of instances to use to support your service
Targets List<GetServiceDefinitionScalingTarget>

Scopes []string: The regions to apply the scaling configuration
Max int: The maximum number of instance to use to support your service
Min int: The minimal number of instances to use to support your service
Targets []GetServiceDefinitionScalingTarget

scopes List<String>: The regions to apply the scaling configuration
max Integer: The maximum number of instance to use to support your service
min Integer: The minimal number of instances to use to support your service
targets List<GetServiceDefinitionScalingTarget>

scopes string[]: The regions to apply the scaling configuration
max number: The maximum number of instance to use to support your service
min number: The minimal number of instances to use to support your service
targets GetServiceDefinitionScalingTarget[]

scopes Sequence[str]: The regions to apply the scaling configuration
max int: The maximum number of instance to use to support your service
min int: The minimal number of instances to use to support your service
targets Sequence[GetServiceDefinitionScalingTarget]

scopes List<String>: The regions to apply the scaling configuration
max Number: The maximum number of instance to use to support your service
min Number: The minimal number of instances to use to support your service
targets List<Property Map>

GetServiceDefinitionScalingTarget

AverageCpus List<GetServiceDefinitionScalingTargetAverageCpus>: The CPU usage (expressed as a percentage) across all Instances of your Service within a region
AverageMems List<GetServiceDefinitionScalingTargetAverageMem>: The memory usage (expressed as a percentage) across all Instances of your Service within a region
ConcurrentRequests List<GetServiceDefinitionScalingTargetConcurrentRequest>: The number of concurrent requests across all Instances of your Service within a region
RequestResponseTimes List<GetServiceDefinitionScalingTargetRequestResponseTime>: The average response time of requests across all Instances of your Service within a region
RequestsPerSeconds List<GetServiceDefinitionScalingTargetRequestsPerSecond>: The number of concurrent requests per second across all Instances of your Service within a region

AverageCpus []GetServiceDefinitionScalingTargetAverageCpus: The CPU usage (expressed as a percentage) across all Instances of your Service within a region
AverageMems []GetServiceDefinitionScalingTargetAverageMem: The memory usage (expressed as a percentage) across all Instances of your Service within a region
ConcurrentRequests []GetServiceDefinitionScalingTargetConcurrentRequest: The number of concurrent requests across all Instances of your Service within a region
RequestResponseTimes []GetServiceDefinitionScalingTargetRequestResponseTime: The average response time of requests across all Instances of your Service within a region
RequestsPerSeconds []GetServiceDefinitionScalingTargetRequestsPerSecond: The number of concurrent requests per second across all Instances of your Service within a region

averageCpus List<GetServiceDefinitionScalingTargetAverageCpus>: The CPU usage (expressed as a percentage) across all Instances of your Service within a region
averageMems List<GetServiceDefinitionScalingTargetAverageMem>: The memory usage (expressed as a percentage) across all Instances of your Service within a region
concurrentRequests List<GetServiceDefinitionScalingTargetConcurrentRequest>: The number of concurrent requests across all Instances of your Service within a region
requestResponseTimes List<GetServiceDefinitionScalingTargetRequestResponseTime>: The average response time of requests across all Instances of your Service within a region
requestsPerSeconds List<GetServiceDefinitionScalingTargetRequestsPerSecond>: The number of concurrent requests per second across all Instances of your Service within a region

averageCpus GetServiceDefinitionScalingTargetAverageCpus[]: The CPU usage (expressed as a percentage) across all Instances of your Service within a region
averageMems GetServiceDefinitionScalingTargetAverageMem[]: The memory usage (expressed as a percentage) across all Instances of your Service within a region
concurrentRequests GetServiceDefinitionScalingTargetConcurrentRequest[]: The number of concurrent requests across all Instances of your Service within a region
requestResponseTimes GetServiceDefinitionScalingTargetRequestResponseTime[]: The average response time of requests across all Instances of your Service within a region
requestsPerSeconds GetServiceDefinitionScalingTargetRequestsPerSecond[]: The number of concurrent requests per second across all Instances of your Service within a region

average_cpus Sequence[GetServiceDefinitionScalingTargetAverageCpus]: The CPU usage (expressed as a percentage) across all Instances of your Service within a region
average_mems Sequence[GetServiceDefinitionScalingTargetAverageMem]: The memory usage (expressed as a percentage) across all Instances of your Service within a region
concurrent_requests Sequence[GetServiceDefinitionScalingTargetConcurrentRequest]: The number of concurrent requests across all Instances of your Service within a region
request_response_times Sequence[GetServiceDefinitionScalingTargetRequestResponseTime]: The average response time of requests across all Instances of your Service within a region
requests_per_seconds Sequence[GetServiceDefinitionScalingTargetRequestsPerSecond]: The number of concurrent requests per second across all Instances of your Service within a region

averageCpus List<Property Map>: The CPU usage (expressed as a percentage) across all Instances of your Service within a region
averageMems List<Property Map>: The memory usage (expressed as a percentage) across all Instances of your Service within a region
concurrentRequests List<Property Map>: The number of concurrent requests across all Instances of your Service within a region
requestResponseTimes List<Property Map>: The average response time of requests across all Instances of your Service within a region
requestsPerSeconds List<Property Map>: The number of concurrent requests per second across all Instances of your Service within a region

GetServiceDefinitionScalingTargetAverageCpus

Value int: The target value of the autoscaling target

Value int: The target value of the autoscaling target

value Integer: The target value of the autoscaling target

value number: The target value of the autoscaling target

value int: The target value of the autoscaling target

value Number: The target value of the autoscaling target

GetServiceDefinitionScalingTargetAverageMem

Value int: The target value of the autoscaling target

Value int: The target value of the autoscaling target

value Integer: The target value of the autoscaling target

value number: The target value of the autoscaling target

value int: The target value of the autoscaling target

value Number: The target value of the autoscaling target

GetServiceDefinitionScalingTargetConcurrentRequest

Value int: The target value of the autoscaling target

Value int: The target value of the autoscaling target

value Integer: The target value of the autoscaling target

value number: The target value of the autoscaling target

value int: The target value of the autoscaling target

value Number: The target value of the autoscaling target

GetServiceDefinitionScalingTargetRequestResponseTime

Value int: The target value of the autoscaling target

Value int: The target value of the autoscaling target

value Integer: The target value of the autoscaling target

value number: The target value of the autoscaling target

value int: The target value of the autoscaling target

value Number: The target value of the autoscaling target

GetServiceDefinitionScalingTargetRequestsPerSecond

Value int: The target value of the autoscaling target

Value int: The target value of the autoscaling target

value Integer: The target value of the autoscaling target

value number: The target value of the autoscaling target

value int: The target value of the autoscaling target

value Number: The target value of the autoscaling target

GetServiceDefinitionVolume

Id string: The volume ID to mount to the service
Path string: The path where to mount the volume
ReplicaIndex int: Explicitly specify the replica index to mount the volume to
Scopes List<string>: The regions to apply the scaling configuration

Id string: The volume ID to mount to the service
Path string: The path where to mount the volume
ReplicaIndex int: Explicitly specify the replica index to mount the volume to
Scopes []string: The regions to apply the scaling configuration

id String: The volume ID to mount to the service
path String: The path where to mount the volume
replicaIndex Integer: Explicitly specify the replica index to mount the volume to
scopes List<String>: The regions to apply the scaling configuration

id string: The volume ID to mount to the service
path string: The path where to mount the volume
replicaIndex number: Explicitly specify the replica index to mount the volume to
scopes string[]: The regions to apply the scaling configuration

id str: The volume ID to mount to the service
path str: The path where to mount the volume
replica_index int: Explicitly specify the replica index to mount the volume to
scopes Sequence[str]: The regions to apply the scaling configuration

id String: The volume ID to mount to the service
path String: The path where to mount the volume
replicaIndex Number: Explicitly specify the replica index to mount the volume to
scopes List<String>: The regions to apply the scaling configuration

Package Details

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

Viewing docs for Koyeb v0.1.11
published on Monday, Dec 9, 2024 by Koyeb

Schema (JSON)

koyeb/pulumi-koyeb

koyeb.getService

On this page

On this page

Example Usage

Using getService

getService Result

Supporting Types

GetServiceDefinition

GetServiceDefinitionDocker

GetServiceDefinitionEnv

GetServiceDefinitionGit

GetServiceDefinitionGitBuildpack

GetServiceDefinitionGitDockerfile

GetServiceDefinitionHealthCheck

GetServiceDefinitionHealthCheckHttp

GetServiceDefinitionHealthCheckHttpHeader

GetServiceDefinitionHealthCheckTcp

GetServiceDefinitionInstanceType

GetServiceDefinitionPort

GetServiceDefinitionRoute

GetServiceDefinitionScaling

GetServiceDefinitionScalingTarget

GetServiceDefinitionScalingTargetAverageCpus

GetServiceDefinitionScalingTargetAverageMem

GetServiceDefinitionScalingTargetConcurrentRequest

GetServiceDefinitionScalingTargetRequestResponseTime

GetServiceDefinitionScalingTargetRequestsPerSecond

GetServiceDefinitionVolume

Package Details

On this page

On this page