Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Koyeb
  3. API Docs
  4. Service
koyeb v0.1.8 published on Friday, Nov 15, 2024 by Koyeb
koyeb/pulumi-koyeb

koyeb.Service

Explore with Pulumi AI

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

    Example Usage

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

const my_service = new koyeb.Service("my-service", {
    appName: myApp.name,
    definition: {
        name: "my-service",
        instanceTypes: [{
            type: "micro",
        }],
        ports: [{
            port: 3000,
            protocol: "http",
        }],
        scalings: [{
            min: 1,
            max: 1,
        }],
        envs: [
            {
                key: "FOO",
                value: "BAR",
            },
            {
                key: "PORT",
                value: "3000",
            },
        ],
        routes: [{
            path: "/",
            port: 3000,
        }],
        regions: ["fra"],
        docker: {
            image: "koyeb/demo",
        },
    },
}, {
    dependsOn: [my_app],
});

    import pulumi
import pulumi_koyeb as koyeb

my_service = koyeb.Service("my-service",
    app_name=my_app["name"],
    definition={
        "name": "my-service",
        "instance_types": [{
            "type": "micro",
        }],
        "ports": [{
            "port": 3000,
            "protocol": "http",
        }],
        "scalings": [{
            "min": 1,
            "max": 1,
        }],
        "envs": [
            {
                "key": "FOO",
                "value": "BAR",
            },
            {
                "key": "PORT",
                "value": "3000",
            },
        ],
        "routes": [{
            "path": "/",
            "port": 3000,
        }],
        "regions": ["fra"],
        "docker": {
            "image": "koyeb/demo",
        },
    },
    opts = pulumi.ResourceOptions(depends_on=[my_app]))

    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.NewService(ctx, "my-service", &koyeb.ServiceArgs{
			AppName: pulumi.Any(myApp.Name),
			Definition: &koyeb.ServiceDefinitionArgs{
				Name: pulumi.String("my-service"),
				InstanceTypes: koyeb.ServiceDefinitionInstanceTypeArray{
					&koyeb.ServiceDefinitionInstanceTypeArgs{
						Type: pulumi.String("micro"),
					},
				},
				Ports: koyeb.ServiceDefinitionPortArray{
					&koyeb.ServiceDefinitionPortArgs{
						Port:     pulumi.Int(3000),
						Protocol: pulumi.String("http"),
					},
				},
				Scalings: koyeb.ServiceDefinitionScalingArray{
					&koyeb.ServiceDefinitionScalingArgs{
						Min: pulumi.Int(1),
						Max: pulumi.Int(1),
					},
				},
				Envs: koyeb.ServiceDefinitionEnvArray{
					&koyeb.ServiceDefinitionEnvArgs{
						Key:   pulumi.String("FOO"),
						Value: pulumi.String("BAR"),
					},
					&koyeb.ServiceDefinitionEnvArgs{
						Key:   pulumi.String("PORT"),
						Value: pulumi.String("3000"),
					},
				},
				Routes: koyeb.ServiceDefinitionRouteArray{
					&koyeb.ServiceDefinitionRouteArgs{
						Path: pulumi.String("/"),
						Port: pulumi.Int(3000),
					},
				},
				Regions: pulumi.StringArray{
					pulumi.String("fra"),
				},
				Docker: &koyeb.ServiceDefinitionDockerArgs{
					Image: pulumi.String("koyeb/demo"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			my_app,
		}))
		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 = new Koyeb.Service("my-service", new()
    {
        AppName = myApp.Name,
        Definition = new Koyeb.Inputs.ServiceDefinitionArgs
        {
            Name = "my-service",
            InstanceTypes = new[]
            {
                new Koyeb.Inputs.ServiceDefinitionInstanceTypeArgs
                {
                    Type = "micro",
                },
            },
            Ports = new[]
            {
                new Koyeb.Inputs.ServiceDefinitionPortArgs
                {
                    Port = 3000,
                    Protocol = "http",
                },
            },
            Scalings = new[]
            {
                new Koyeb.Inputs.ServiceDefinitionScalingArgs
                {
                    Min = 1,
                    Max = 1,
                },
            },
            Envs = new[]
            {
                new Koyeb.Inputs.ServiceDefinitionEnvArgs
                {
                    Key = "FOO",
                    Value = "BAR",
                },
                new Koyeb.Inputs.ServiceDefinitionEnvArgs
                {
                    Key = "PORT",
                    Value = "3000",
                },
            },
            Routes = new[]
            {
                new Koyeb.Inputs.ServiceDefinitionRouteArgs
                {
                    Path = "/",
                    Port = 3000,
                },
            },
            Regions = new[]
            {
                "fra",
            },
            Docker = new Koyeb.Inputs.ServiceDefinitionDockerArgs
            {
                Image = "koyeb/demo",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            my_app,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.koyeb.Service;
import com.pulumi.koyeb.ServiceArgs;
import com.pulumi.koyeb.inputs.ServiceDefinitionArgs;
import com.pulumi.koyeb.inputs.ServiceDefinitionDockerArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        var my_service = new Service("my-service", ServiceArgs.builder()
            .appName(myApp.name())
            .definition(ServiceDefinitionArgs.builder()
                .name("my-service")
                .instanceTypes(ServiceDefinitionInstanceTypeArgs.builder()
                    .type("micro")
                    .build())
                .ports(ServiceDefinitionPortArgs.builder()
                    .port(3000)
                    .protocol("http")
                    .build())
                .scalings(ServiceDefinitionScalingArgs.builder()
                    .min(1)
                    .max(1)
                    .build())
                .envs(                
                    ServiceDefinitionEnvArgs.builder()
                        .key("FOO")
                        .value("BAR")
                        .build(),
                    ServiceDefinitionEnvArgs.builder()
                        .key("PORT")
                        .value("3000")
                        .build())
                .routes(ServiceDefinitionRouteArgs.builder()
                    .path("/")
                    .port(3000)
                    .build())
                .regions("fra")
                .docker(ServiceDefinitionDockerArgs.builder()
                    .image("koyeb/demo")
                    .build())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(my_app)
                .build());

    }
}

    resources:
  my-service:
    type: koyeb:Service
    properties:
      appName: ${myApp.name}
      definition:
        name: my-service
        instanceTypes:
          - type: micro
        ports:
          - port: 3000
            protocol: http
        scalings:
          - min: 1
            max: 1
        envs:
          - key: FOO
            value: BAR
          - key: PORT
            value: '3000'
        routes:
          - path: /
            port: 3000
        regions:
          - fra
        docker:
          image: koyeb/demo
    options:
      dependson:
        - ${["my-app"]}

    Create Service Resource

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

    Constructor syntax

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

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            app_name: Optional[str] = None,
            definition: Optional[ServiceDefinitionArgs] = None,
            messages: Optional[str] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: koyeb:Service
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 ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 serviceResource = new Koyeb.Service("serviceResource", new()
{
    AppName = "string",
    Definition = new Koyeb.Inputs.ServiceDefinitionArgs
    {
        InstanceTypes = new[]
        {
            new Koyeb.Inputs.ServiceDefinitionInstanceTypeArgs
            {
                Type = "string",
                Scopes = new[]
                {
                    "string",
                },
            },
        },
        Name = "string",
        Ports = new[]
        {
            new Koyeb.Inputs.ServiceDefinitionPortArgs
            {
                Port = 0,
                Protocol = "string",
            },
        },
        Regions = new[]
        {
            "string",
        },
        Scalings = new[]
        {
            new Koyeb.Inputs.ServiceDefinitionScalingArgs
            {
                Max = 0,
                Min = 0,
                Scopes = new[]
                {
                    "string",
                },
                Targets = new[]
                {
                    new Koyeb.Inputs.ServiceDefinitionScalingTargetArgs
                    {
                        AverageCpus = new[]
                        {
                            new Koyeb.Inputs.ServiceDefinitionScalingTargetAverageCpusArgs
                            {
                                Value = 0,
                            },
                        },
                        AverageMems = new[]
                        {
                            new Koyeb.Inputs.ServiceDefinitionScalingTargetAverageMemArgs
                            {
                                Value = 0,
                            },
                        },
                        RequestsPerSeconds = new[]
                        {
                            new Koyeb.Inputs.ServiceDefinitionScalingTargetRequestsPerSecondArgs
                            {
                                Value = 0,
                            },
                        },
                    },
                },
            },
        },
        Docker = new Koyeb.Inputs.ServiceDefinitionDockerArgs
        {
            Image = "string",
            Args = new[]
            {
                "string",
            },
            Command = "string",
            Entrypoints = new[]
            {
                "string",
            },
            ImageRegistrySecret = "string",
            Privileged = false,
        },
        Envs = new[]
        {
            new Koyeb.Inputs.ServiceDefinitionEnvArgs
            {
                Key = "string",
                Scopes = new[]
                {
                    "string",
                },
                Secret = "string",
                Value = "string",
            },
        },
        Git = new Koyeb.Inputs.ServiceDefinitionGitArgs
        {
            Branch = "string",
            Repository = "string",
            Buildpack = new Koyeb.Inputs.ServiceDefinitionGitBuildpackArgs
            {
                BuildCommand = "string",
                Privileged = false,
                RunCommand = "string",
            },
            Dockerfile = new Koyeb.Inputs.ServiceDefinitionGitDockerfileArgs
            {
                Args = new[]
                {
                    "string",
                },
                Command = "string",
                Dockerfile = "string",
                Entrypoints = new[]
                {
                    "string",
                },
                Privileged = false,
                Target = "string",
            },
            NoDeployOnPush = false,
            Workdir = "string",
        },
        HealthChecks = new[]
        {
            new Koyeb.Inputs.ServiceDefinitionHealthCheckArgs
            {
                GracePeriod = 0,
                Http = new Koyeb.Inputs.ServiceDefinitionHealthCheckHttpArgs
                {
                    Path = "string",
                    Port = 0,
                    Headers = new[]
                    {
                        new Koyeb.Inputs.ServiceDefinitionHealthCheckHttpHeaderArgs
                        {
                            Key = "string",
                            Value = "string",
                        },
                    },
                    Method = "string",
                },
                Interval = 0,
                RestartLimit = 0,
                Tcp = new Koyeb.Inputs.ServiceDefinitionHealthCheckTcpArgs
                {
                    Port = 0,
                },
                Timeout = 0,
            },
        },
        Routes = new[]
        {
            new Koyeb.Inputs.ServiceDefinitionRouteArgs
            {
                Path = "string",
                Port = 0,
            },
        },
        SkipCache = false,
        Type = "string",
    },
    Messages = "string",
});

    example, err := koyeb.NewService(ctx, "serviceResource", &koyeb.ServiceArgs{
	AppName: pulumi.String("string"),
	Definition: &koyeb.ServiceDefinitionArgs{
		InstanceTypes: koyeb.ServiceDefinitionInstanceTypeArray{
			&koyeb.ServiceDefinitionInstanceTypeArgs{
				Type: pulumi.String("string"),
				Scopes: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		Name: pulumi.String("string"),
		Ports: koyeb.ServiceDefinitionPortArray{
			&koyeb.ServiceDefinitionPortArgs{
				Port:     pulumi.Int(0),
				Protocol: pulumi.String("string"),
			},
		},
		Regions: pulumi.StringArray{
			pulumi.String("string"),
		},
		Scalings: koyeb.ServiceDefinitionScalingArray{
			&koyeb.ServiceDefinitionScalingArgs{
				Max: pulumi.Int(0),
				Min: pulumi.Int(0),
				Scopes: pulumi.StringArray{
					pulumi.String("string"),
				},
				Targets: koyeb.ServiceDefinitionScalingTargetArray{
					&koyeb.ServiceDefinitionScalingTargetArgs{
						AverageCpus: koyeb.ServiceDefinitionScalingTargetAverageCpusArray{
							&koyeb.ServiceDefinitionScalingTargetAverageCpusArgs{
								Value: pulumi.Int(0),
							},
						},
						AverageMems: koyeb.ServiceDefinitionScalingTargetAverageMemArray{
							&koyeb.ServiceDefinitionScalingTargetAverageMemArgs{
								Value: pulumi.Int(0),
							},
						},
						RequestsPerSeconds: koyeb.ServiceDefinitionScalingTargetRequestsPerSecondArray{
							&koyeb.ServiceDefinitionScalingTargetRequestsPerSecondArgs{
								Value: pulumi.Int(0),
							},
						},
					},
				},
			},
		},
		Docker: &koyeb.ServiceDefinitionDockerArgs{
			Image: pulumi.String("string"),
			Args: pulumi.StringArray{
				pulumi.String("string"),
			},
			Command: pulumi.String("string"),
			Entrypoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			ImageRegistrySecret: pulumi.String("string"),
			Privileged:          pulumi.Bool(false),
		},
		Envs: koyeb.ServiceDefinitionEnvArray{
			&koyeb.ServiceDefinitionEnvArgs{
				Key: pulumi.String("string"),
				Scopes: pulumi.StringArray{
					pulumi.String("string"),
				},
				Secret: pulumi.String("string"),
				Value:  pulumi.String("string"),
			},
		},
		Git: &koyeb.ServiceDefinitionGitArgs{
			Branch:     pulumi.String("string"),
			Repository: pulumi.String("string"),
			Buildpack: &koyeb.ServiceDefinitionGitBuildpackArgs{
				BuildCommand: pulumi.String("string"),
				Privileged:   pulumi.Bool(false),
				RunCommand:   pulumi.String("string"),
			},
			Dockerfile: &koyeb.ServiceDefinitionGitDockerfileArgs{
				Args: pulumi.StringArray{
					pulumi.String("string"),
				},
				Command:    pulumi.String("string"),
				Dockerfile: pulumi.String("string"),
				Entrypoints: pulumi.StringArray{
					pulumi.String("string"),
				},
				Privileged: pulumi.Bool(false),
				Target:     pulumi.String("string"),
			},
			NoDeployOnPush: pulumi.Bool(false),
			Workdir:        pulumi.String("string"),
		},
		HealthChecks: koyeb.ServiceDefinitionHealthCheckArray{
			&koyeb.ServiceDefinitionHealthCheckArgs{
				GracePeriod: pulumi.Int(0),
				Http: &koyeb.ServiceDefinitionHealthCheckHttpArgs{
					Path: pulumi.String("string"),
					Port: pulumi.Int(0),
					Headers: koyeb.ServiceDefinitionHealthCheckHttpHeaderArray{
						&koyeb.ServiceDefinitionHealthCheckHttpHeaderArgs{
							Key:   pulumi.String("string"),
							Value: pulumi.String("string"),
						},
					},
					Method: pulumi.String("string"),
				},
				Interval:     pulumi.Int(0),
				RestartLimit: pulumi.Int(0),
				Tcp: &koyeb.ServiceDefinitionHealthCheckTcpArgs{
					Port: pulumi.Int(0),
				},
				Timeout: pulumi.Int(0),
			},
		},
		Routes: koyeb.ServiceDefinitionRouteArray{
			&koyeb.ServiceDefinitionRouteArgs{
				Path: pulumi.String("string"),
				Port: pulumi.Int(0),
			},
		},
		SkipCache: pulumi.Bool(false),
		Type:      pulumi.String("string"),
	},
	Messages: pulumi.String("string"),
})

    var serviceResource = new Service("serviceResource", ServiceArgs.builder()
    .appName("string")
    .definition(ServiceDefinitionArgs.builder()
        .instanceTypes(ServiceDefinitionInstanceTypeArgs.builder()
            .type("string")
            .scopes("string")
            .build())
        .name("string")
        .ports(ServiceDefinitionPortArgs.builder()
            .port(0)
            .protocol("string")
            .build())
        .regions("string")
        .scalings(ServiceDefinitionScalingArgs.builder()
            .max(0)
            .min(0)
            .scopes("string")
            .targets(ServiceDefinitionScalingTargetArgs.builder()
                .averageCpus(ServiceDefinitionScalingTargetAverageCpusArgs.builder()
                    .value(0)
                    .build())
                .averageMems(ServiceDefinitionScalingTargetAverageMemArgs.builder()
                    .value(0)
                    .build())
                .requestsPerSeconds(ServiceDefinitionScalingTargetRequestsPerSecondArgs.builder()
                    .value(0)
                    .build())
                .build())
            .build())
        .docker(ServiceDefinitionDockerArgs.builder()
            .image("string")
            .args("string")
            .command("string")
            .entrypoints("string")
            .imageRegistrySecret("string")
            .privileged(false)
            .build())
        .envs(ServiceDefinitionEnvArgs.builder()
            .key("string")
            .scopes("string")
            .secret("string")
            .value("string")
            .build())
        .git(ServiceDefinitionGitArgs.builder()
            .branch("string")
            .repository("string")
            .buildpack(ServiceDefinitionGitBuildpackArgs.builder()
                .buildCommand("string")
                .privileged(false)
                .runCommand("string")
                .build())
            .dockerfile(ServiceDefinitionGitDockerfileArgs.builder()
                .args("string")
                .command("string")
                .dockerfile("string")
                .entrypoints("string")
                .privileged(false)
                .target("string")
                .build())
            .noDeployOnPush(false)
            .workdir("string")
            .build())
        .healthChecks(ServiceDefinitionHealthCheckArgs.builder()
            .gracePeriod(0)
            .http(ServiceDefinitionHealthCheckHttpArgs.builder()
                .path("string")
                .port(0)
                .headers(ServiceDefinitionHealthCheckHttpHeaderArgs.builder()
                    .key("string")
                    .value("string")
                    .build())
                .method("string")
                .build())
            .interval(0)
            .restartLimit(0)
            .tcp(ServiceDefinitionHealthCheckTcpArgs.builder()
                .port(0)
                .build())
            .timeout(0)
            .build())
        .routes(ServiceDefinitionRouteArgs.builder()
            .path("string")
            .port(0)
            .build())
        .skipCache(false)
        .type("string")
        .build())
    .messages("string")
    .build());

    service_resource = koyeb.Service("serviceResource",
    app_name="string",
    definition={
        "instance_types": [{
            "type": "string",
            "scopes": ["string"],
        }],
        "name": "string",
        "ports": [{
            "port": 0,
            "protocol": "string",
        }],
        "regions": ["string"],
        "scalings": [{
            "max": 0,
            "min": 0,
            "scopes": ["string"],
            "targets": [{
                "average_cpus": [{
                    "value": 0,
                }],
                "average_mems": [{
                    "value": 0,
                }],
                "requests_per_seconds": [{
                    "value": 0,
                }],
            }],
        }],
        "docker": {
            "image": "string",
            "args": ["string"],
            "command": "string",
            "entrypoints": ["string"],
            "image_registry_secret": "string",
            "privileged": False,
        },
        "envs": [{
            "key": "string",
            "scopes": ["string"],
            "secret": "string",
            "value": "string",
        }],
        "git": {
            "branch": "string",
            "repository": "string",
            "buildpack": {
                "build_command": "string",
                "privileged": False,
                "run_command": "string",
            },
            "dockerfile": {
                "args": ["string"],
                "command": "string",
                "dockerfile": "string",
                "entrypoints": ["string"],
                "privileged": False,
                "target": "string",
            },
            "no_deploy_on_push": False,
            "workdir": "string",
        },
        "health_checks": [{
            "grace_period": 0,
            "http": {
                "path": "string",
                "port": 0,
                "headers": [{
                    "key": "string",
                    "value": "string",
                }],
                "method": "string",
            },
            "interval": 0,
            "restart_limit": 0,
            "tcp": {
                "port": 0,
            },
            "timeout": 0,
        }],
        "routes": [{
            "path": "string",
            "port": 0,
        }],
        "skip_cache": False,
        "type": "string",
    },
    messages="string")

    const serviceResource = new koyeb.Service("serviceResource", {
    appName: "string",
    definition: {
        instanceTypes: [{
            type: "string",
            scopes: ["string"],
        }],
        name: "string",
        ports: [{
            port: 0,
            protocol: "string",
        }],
        regions: ["string"],
        scalings: [{
            max: 0,
            min: 0,
            scopes: ["string"],
            targets: [{
                averageCpus: [{
                    value: 0,
                }],
                averageMems: [{
                    value: 0,
                }],
                requestsPerSeconds: [{
                    value: 0,
                }],
            }],
        }],
        docker: {
            image: "string",
            args: ["string"],
            command: "string",
            entrypoints: ["string"],
            imageRegistrySecret: "string",
            privileged: false,
        },
        envs: [{
            key: "string",
            scopes: ["string"],
            secret: "string",
            value: "string",
        }],
        git: {
            branch: "string",
            repository: "string",
            buildpack: {
                buildCommand: "string",
                privileged: false,
                runCommand: "string",
            },
            dockerfile: {
                args: ["string"],
                command: "string",
                dockerfile: "string",
                entrypoints: ["string"],
                privileged: false,
                target: "string",
            },
            noDeployOnPush: false,
            workdir: "string",
        },
        healthChecks: [{
            gracePeriod: 0,
            http: {
                path: "string",
                port: 0,
                headers: [{
                    key: "string",
                    value: "string",
                }],
                method: "string",
            },
            interval: 0,
            restartLimit: 0,
            tcp: {
                port: 0,
            },
            timeout: 0,
        }],
        routes: [{
            path: "string",
            port: 0,
        }],
        skipCache: false,
        type: "string",
    },
    messages: "string",
});

    type: koyeb:Service
properties:
    appName: string
    definition:
        docker:
            args:
                - string
            command: string
            entrypoints:
                - string
            image: string
            imageRegistrySecret: string
            privileged: false
        envs:
            - key: string
              scopes:
                - string
              secret: string
              value: string
        git:
            branch: string
            buildpack:
                buildCommand: string
                privileged: false
                runCommand: string
            dockerfile:
                args:
                    - string
                command: string
                dockerfile: string
                entrypoints:
                    - string
                privileged: false
                target: string
            noDeployOnPush: false
            repository: string
            workdir: string
        healthChecks:
            - gracePeriod: 0
              http:
                headers:
                    - key: string
                      value: string
                method: string
                path: string
                port: 0
              interval: 0
              restartLimit: 0
              tcp:
                port: 0
              timeout: 0
        instanceTypes:
            - scopes:
                - string
              type: string
        name: string
        ports:
            - port: 0
              protocol: string
        regions:
            - string
        routes:
            - path: string
              port: 0
        scalings:
            - max: 0
              min: 0
              scopes:
                - string
              targets:
                - averageCpus:
                    - value: 0
                  averageMems:
                    - value: 0
                  requestsPerSeconds:
                    - value: 0
        skipCache: false
        type: string
    messages: string

    Service 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 Service resource accepts the following input properties:

    AppName string
    The app name the service is assigned to
    Definition ServiceDefinition
    The service deployment definition
    Messages string
    The status messages of the service
    AppName string
    The app name the service is assigned to
    Definition ServiceDefinitionArgs
    The service deployment definition
    Messages string
    The status messages of the service
    appName String
    The app name the service is assigned to
    definition ServiceDefinition
    The service deployment definition
    messages String
    The status messages of the service
    appName string
    The app name the service is assigned to
    definition ServiceDefinition
    The service deployment definition
    messages string
    The status messages of the service
    app_name str
    The app name the service is assigned to
    definition ServiceDefinitionArgs
    The service deployment definition
    messages str
    The status messages of the service
    appName String
    The app name the service is assigned to
    definition Property Map
    The service deployment definition
    messages String
    The status messages of the service

    Outputs

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

    ActiveDeployment string
    The service active deployment ID
    AppId string
    The app id the service is assigned to
    CreatedAt string
    The date and time of when the service was created
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestDeployment string
    The service latest deployment ID
    Name string
    The service name
    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
    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 to
    CreatedAt string
    The date and time of when the service was created
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestDeployment string
    The service latest deployment ID
    Name string
    The service name
    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
    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 to
    createdAt String
    The date and time of when the service was created
    id String
    The provider-assigned unique ID for this managed resource.
    latestDeployment String
    The service latest deployment ID
    name String
    The service name
    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
    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 to
    createdAt string
    The date and time of when the service was created
    id string
    The provider-assigned unique ID for this managed resource.
    latestDeployment string
    The service latest deployment ID
    name string
    The service name
    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
    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 to
    created_at str
    The date and time of when the service was created
    id str
    The provider-assigned unique ID for this managed resource.
    latest_deployment str
    The service latest deployment ID
    name str
    The service name
    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
    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 to
    createdAt String
    The date and time of when the service was created
    id String
    The provider-assigned unique ID for this managed resource.
    latestDeployment String
    The service latest deployment ID
    name String
    The service name
    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
    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

    Look up Existing Service Resource

    Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_deployment: Optional[str] = None,
        app_id: Optional[str] = None,
        app_name: Optional[str] = None,
        created_at: Optional[str] = None,
        definition: Optional[ServiceDefinitionArgs] = None,
        latest_deployment: Optional[str] = None,
        messages: Optional[str] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        paused_at: Optional[str] = None,
        resumed_at: Optional[str] = None,
        status: Optional[str] = None,
        terminated_at: Optional[str] = None,
        updated_at: Optional[str] = None,
        version: Optional[str] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ActiveDeployment string
    The service active deployment ID
    AppId string
    The app id the service is assigned to
    AppName string
    The app name the service is assigned to
    CreatedAt string
    The date and time of when the service was created
    Definition ServiceDefinition
    The service deployment definition
    LatestDeployment string
    The service latest deployment ID
    Messages string
    The status messages of the service
    Name string
    The service name
    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
    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 to
    AppName string
    The app name the service is assigned to
    CreatedAt string
    The date and time of when the service was created
    Definition ServiceDefinitionArgs
    The service deployment definition
    LatestDeployment string
    The service latest deployment ID
    Messages string
    The status messages of the service
    Name string
    The service name
    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
    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 to
    appName String
    The app name the service is assigned to
    createdAt String
    The date and time of when the service was created
    definition ServiceDefinition
    The service deployment definition
    latestDeployment String
    The service latest deployment ID
    messages String
    The status messages of the service
    name String
    The service name
    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
    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 to
    appName string
    The app name the service is assigned to
    createdAt string
    The date and time of when the service was created
    definition ServiceDefinition
    The service deployment definition
    latestDeployment string
    The service latest deployment ID
    messages string
    The status messages of the service
    name string
    The service name
    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
    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 to
    app_name str
    The app name the service is assigned to
    created_at str
    The date and time of when the service was created
    definition ServiceDefinitionArgs
    The service deployment definition
    latest_deployment str
    The service latest deployment ID
    messages str
    The status messages of the service
    name str
    The service name
    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
    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 to
    appName String
    The app name the service is assigned to
    createdAt String
    The date and time of when the service was created
    definition Property Map
    The service deployment definition
    latestDeployment String
    The service latest deployment ID
    messages String
    The status messages of the service
    name String
    The service name
    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
    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

    ServiceDefinition, ServiceDefinitionArgs

    InstanceTypes List<ServiceDefinitionInstanceType>
    Name string
    The service name
    Ports List<ServiceDefinitionPort>
    Regions List<string>
    The service deployment regions to deploy to
    Scalings List<ServiceDefinitionScaling>
    Docker ServiceDefinitionDocker
    Envs List<ServiceDefinitionEnv>
    Git ServiceDefinitionGit
    HealthChecks List<ServiceDefinitionHealthCheck>
    Routes List<ServiceDefinitionRoute>
    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)
    InstanceTypes []ServiceDefinitionInstanceType
    Name string
    The service name
    Ports []ServiceDefinitionPort
    Regions []string
    The service deployment regions to deploy to
    Scalings []ServiceDefinitionScaling
    Docker ServiceDefinitionDocker
    Envs []ServiceDefinitionEnv
    Git ServiceDefinitionGit
    HealthChecks []ServiceDefinitionHealthCheck
    Routes []ServiceDefinitionRoute
    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)
    instanceTypes List<ServiceDefinitionInstanceType>
    name String
    The service name
    ports List<ServiceDefinitionPort>
    regions List<String>
    The service deployment regions to deploy to
    scalings List<ServiceDefinitionScaling>
    docker ServiceDefinitionDocker
    envs List<ServiceDefinitionEnv>
    git ServiceDefinitionGit
    healthChecks List<ServiceDefinitionHealthCheck>
    routes List<ServiceDefinitionRoute>
    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)
    instanceTypes ServiceDefinitionInstanceType[]
    name string
    The service name
    ports ServiceDefinitionPort[]
    regions string[]
    The service deployment regions to deploy to
    scalings ServiceDefinitionScaling[]
    docker ServiceDefinitionDocker
    envs ServiceDefinitionEnv[]
    git ServiceDefinitionGit
    healthChecks ServiceDefinitionHealthCheck[]
    routes ServiceDefinitionRoute[]
    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)
    instanceTypes List<Property Map>
    name String
    The service name
    ports List<Property Map>
    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>
    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)

    ServiceDefinitionDocker, ServiceDefinitionDockerArgs

    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.

    ServiceDefinitionEnv, ServiceDefinitionEnvArgs

    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

    ServiceDefinitionGit, ServiceDefinitionGitArgs

    Branch string
    The GitHub branch to deploy
    Repository string
    The GitHub repository to deploy
    Buildpack ServiceDefinitionGitBuildpack
    Dockerfile ServiceDefinitionGitDockerfile
    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 ServiceDefinitionGitBuildpack
    Dockerfile ServiceDefinitionGitDockerfile
    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 ServiceDefinitionGitBuildpack
    dockerfile ServiceDefinitionGitDockerfile
    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 ServiceDefinitionGitBuildpack
    dockerfile ServiceDefinitionGitDockerfile
    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 ServiceDefinitionGitBuildpack
    dockerfile ServiceDefinitionGitDockerfile
    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.

    ServiceDefinitionGitBuildpack, ServiceDefinitionGitBuildpackArgs

    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

    ServiceDefinitionGitDockerfile, ServiceDefinitionGitDockerfileArgs

    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

    ServiceDefinitionHealthCheck, ServiceDefinitionHealthCheckArgs

    GracePeriod int
    The period in seconds to wait for the instance to become healthy, default is 5s
    Http ServiceDefinitionHealthCheckHttp
    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 ServiceDefinitionHealthCheckTcp
    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 ServiceDefinitionHealthCheckHttp
    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 ServiceDefinitionHealthCheckTcp
    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 ServiceDefinitionHealthCheckHttp
    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 ServiceDefinitionHealthCheckTcp
    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 ServiceDefinitionHealthCheckHttp
    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 ServiceDefinitionHealthCheckTcp
    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 ServiceDefinitionHealthCheckHttp
    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 ServiceDefinitionHealthCheckTcp
    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

    ServiceDefinitionHealthCheckHttp, ServiceDefinitionHealthCheckHttpArgs

    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<ServiceDefinitionHealthCheckHttpHeader>
    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 []ServiceDefinitionHealthCheckHttpHeader
    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<ServiceDefinitionHealthCheckHttpHeader>
    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 ServiceDefinitionHealthCheckHttpHeader[]
    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[ServiceDefinitionHealthCheckHttpHeader]
    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

    ServiceDefinitionHealthCheckHttpHeader, ServiceDefinitionHealthCheckHttpHeaderArgs

    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

    ServiceDefinitionHealthCheckTcp, ServiceDefinitionHealthCheckTcpArgs

    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

    ServiceDefinitionInstanceType, ServiceDefinitionInstanceTypeArgs

    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 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 str
    The instance type to use to support your service
    scopes Sequence[str]
    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

    ServiceDefinitionPort, ServiceDefinitionPortArgs

    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

    ServiceDefinitionRoute, ServiceDefinitionRouteArgs

    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

    ServiceDefinitionScaling, ServiceDefinitionScalingArgs

    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
    Scopes List<string>
    The regions to apply the scaling configuration
    Targets List<ServiceDefinitionScalingTarget>
    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
    Scopes []string
    The regions to apply the scaling configuration
    Targets []ServiceDefinitionScalingTarget
    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
    scopes List<String>
    The regions to apply the scaling configuration
    targets List<ServiceDefinitionScalingTarget>
    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
    scopes string[]
    The regions to apply the scaling configuration
    targets ServiceDefinitionScalingTarget[]
    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
    scopes Sequence[str]
    The regions to apply the scaling configuration
    targets Sequence[ServiceDefinitionScalingTarget]
    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
    scopes List<String>
    The regions to apply the scaling configuration
    targets List<Property Map>

    ServiceDefinitionScalingTarget, ServiceDefinitionScalingTargetArgs

    AverageCpus List<ServiceDefinitionScalingTargetAverageCpus>
    The CPU usage (expressed as a percentage) across all Instances of your Service within a region
    AverageMems List<ServiceDefinitionScalingTargetAverageMem>
    The memory usage (expressed as a percentage) across all Instances of your Service within a region
    RequestsPerSeconds List<ServiceDefinitionScalingTargetRequestsPerSecond>
    The number of concurrent requests per second across all Instances of your Service within a region
    AverageCpus []ServiceDefinitionScalingTargetAverageCpus
    The CPU usage (expressed as a percentage) across all Instances of your Service within a region
    AverageMems []ServiceDefinitionScalingTargetAverageMem
    The memory usage (expressed as a percentage) across all Instances of your Service within a region
    RequestsPerSeconds []ServiceDefinitionScalingTargetRequestsPerSecond
    The number of concurrent requests per second across all Instances of your Service within a region
    averageCpus List<ServiceDefinitionScalingTargetAverageCpus>
    The CPU usage (expressed as a percentage) across all Instances of your Service within a region
    averageMems List<ServiceDefinitionScalingTargetAverageMem>
    The memory usage (expressed as a percentage) across all Instances of your Service within a region
    requestsPerSeconds List<ServiceDefinitionScalingTargetRequestsPerSecond>
    The number of concurrent requests per second across all Instances of your Service within a region
    averageCpus ServiceDefinitionScalingTargetAverageCpus[]
    The CPU usage (expressed as a percentage) across all Instances of your Service within a region
    averageMems ServiceDefinitionScalingTargetAverageMem[]
    The memory usage (expressed as a percentage) across all Instances of your Service within a region
    requestsPerSeconds ServiceDefinitionScalingTargetRequestsPerSecond[]
    The number of concurrent requests per second across all Instances of your Service within a region
    average_cpus Sequence[ServiceDefinitionScalingTargetAverageCpus]
    The CPU usage (expressed as a percentage) across all Instances of your Service within a region
    average_mems Sequence[ServiceDefinitionScalingTargetAverageMem]
    The memory usage (expressed as a percentage) across all Instances of your Service within a region
    requests_per_seconds Sequence[ServiceDefinitionScalingTargetRequestsPerSecond]
    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
    requestsPerSeconds List<Property Map>
    The number of concurrent requests per second across all Instances of your Service within a region

    ServiceDefinitionScalingTargetAverageCpus, ServiceDefinitionScalingTargetAverageCpusArgs

    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

    ServiceDefinitionScalingTargetAverageMem, ServiceDefinitionScalingTargetAverageMemArgs

    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

    ServiceDefinitionScalingTargetRequestsPerSecond, ServiceDefinitionScalingTargetRequestsPerSecondArgs

    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

    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
    koyeb/pulumi-koyeb