Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. Function
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.Function

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

    Define function-as-a-service using various backends. Currently, only siderite (HSDP Iron) is supported.

    Example Usage

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

const rdsBackup = new hsdp.Function("rdsBackup", {
    dockerImage: _var.streaming_backup_image,
    dockerCredentials: {
        username: _var.docker_username,
        password: _var.docker_password,
    },
    environment: {
        db_name: "hsdp_pg",
        db_host: "rds.aws.com",
        db_username: _var.db_username,
        db_password: _var.db_password,
        s3_access_key: "AAA",
        s3_secret_key: "BBB",
        s3_bucket: "cf-s3-xxx",
        s3_prefix: "/backups",
    },
    schedule: "0 4 * * *",
    backend: {
        credentials: module.siderite_backend.credentials,
    },
});

    import pulumi
import pulumi_hsdp as hsdp

rds_backup = hsdp.Function("rdsBackup",
    docker_image=var["streaming_backup_image"],
    docker_credentials={
        "username": var["docker_username"],
        "password": var["docker_password"],
    },
    environment={
        "db_name": "hsdp_pg",
        "db_host": "rds.aws.com",
        "db_username": var["db_username"],
        "db_password": var["db_password"],
        "s3_access_key": "AAA",
        "s3_secret_key": "BBB",
        "s3_bucket": "cf-s3-xxx",
        "s3_prefix": "/backups",
    },
    schedule="0 4 * * *",
    backend={
        "credentials": module["siderite_backend"]["credentials"],
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hsdp.NewFunction(ctx, "rdsBackup", &hsdp.FunctionArgs{
			DockerImage: pulumi.Any(_var.Streaming_backup_image),
			DockerCredentials: pulumi.StringMap{
				"username": pulumi.Any(_var.Docker_username),
				"password": pulumi.Any(_var.Docker_password),
			},
			Environment: pulumi.StringMap{
				"db_name":       pulumi.String("hsdp_pg"),
				"db_host":       pulumi.String("rds.aws.com"),
				"db_username":   pulumi.Any(_var.Db_username),
				"db_password":   pulumi.Any(_var.Db_password),
				"s3_access_key": pulumi.String("AAA"),
				"s3_secret_key": pulumi.String("BBB"),
				"s3_bucket":     pulumi.String("cf-s3-xxx"),
				"s3_prefix":     pulumi.String("/backups"),
			},
			Schedule: pulumi.String("0 4 * * *"),
			Backend: &hsdp.FunctionBackendArgs{
				Credentials: pulumi.Any(module.Siderite_backend.Credentials),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Hsdp = Pulumi.Hsdp;

return await Deployment.RunAsync(() => 
{
    var rdsBackup = new Hsdp.Function("rdsBackup", new()
    {
        DockerImage = @var.Streaming_backup_image,
        DockerCredentials = 
        {
            { "username", @var.Docker_username },
            { "password", @var.Docker_password },
        },
        Environment = 
        {
            { "db_name", "hsdp_pg" },
            { "db_host", "rds.aws.com" },
            { "db_username", @var.Db_username },
            { "db_password", @var.Db_password },
            { "s3_access_key", "AAA" },
            { "s3_secret_key", "BBB" },
            { "s3_bucket", "cf-s3-xxx" },
            { "s3_prefix", "/backups" },
        },
        Schedule = "0 4 * * *",
        Backend = new Hsdp.Inputs.FunctionBackendArgs
        {
            Credentials = module.Siderite_backend.Credentials,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.Function;
import com.pulumi.hsdp.FunctionArgs;
import com.pulumi.hsdp.inputs.FunctionBackendArgs;
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 rdsBackup = new Function("rdsBackup", FunctionArgs.builder()
            .dockerImage(var_.streaming_backup_image())
            .dockerCredentials(Map.ofEntries(
                Map.entry("username", var_.docker_username()),
                Map.entry("password", var_.docker_password())
            ))
            .environment(Map.ofEntries(
                Map.entry("db_name", "hsdp_pg"),
                Map.entry("db_host", "rds.aws.com"),
                Map.entry("db_username", var_.db_username()),
                Map.entry("db_password", var_.db_password()),
                Map.entry("s3_access_key", "AAA"),
                Map.entry("s3_secret_key", "BBB"),
                Map.entry("s3_bucket", "cf-s3-xxx"),
                Map.entry("s3_prefix", "/backups")
            ))
            .schedule("0 4 * * *")
            .backend(FunctionBackendArgs.builder()
                .credentials(module.siderite_backend().credentials())
                .build())
            .build());

    }
}

    resources:
  rdsBackup:
    type: hsdp:Function
    properties:
      # The docker packaged function business logic
      dockerImage: ${var.streaming_backup_image}
      dockerCredentials:
        username: ${var.docker_username}
        password: ${var.docker_password}
      # Environment variables available in the container
      environment:
        db_name: hsdp_pg
        db_host: rds.aws.com
        db_username: ${var.db_username}
        db_password: ${var.db_password}
        s3_access_key: AAA
        s3_secret_key: BBB
        s3_bucket: cf-s3-xxx
        s3_prefix: /backups
      # Run every day at 4am
      schedule: 0 4 * * *
      backend:
        credentials: ${module.siderite_backend.credentials}

    Create Function Resource

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

    Constructor syntax

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

@overload
def Function(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             backend: Optional[FunctionBackendArgs] = None,
             docker_image: Optional[str] = None,
             commands: Optional[Sequence[str]] = None,
             docker_credentials: Optional[Mapping[str, str]] = None,
             environment: Optional[Mapping[str, str]] = None,
             function_id: Optional[str] = None,
             name: Optional[str] = None,
             run_every: Optional[str] = None,
             schedule: Optional[str] = None,
             start_at: Optional[str] = None,
             timeout: Optional[float] = None)
    func NewFunction(ctx *Context, name string, args FunctionArgs, opts ...ResourceOption) (*Function, error)
    public Function(string name, FunctionArgs args, CustomResourceOptions? opts = null)
    public Function(String name, FunctionArgs args)
public Function(String name, FunctionArgs args, CustomResourceOptions options)

    type: hsdp:Function
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 FunctionArgs
    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 FunctionArgs
    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 FunctionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FunctionArgs
    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 functionResource = new Hsdp.Function("functionResource", new()
{
    Backend = new Hsdp.Inputs.FunctionBackendArgs
    {
        Credentials = 
        {
            { "string", "string" },
        },
    },
    DockerImage = "string",
    Commands = new[]
    {
        "string",
    },
    DockerCredentials = 
    {
        { "string", "string" },
    },
    Environment = 
    {
        { "string", "string" },
    },
    FunctionId = "string",
    Name = "string",
    RunEvery = "string",
    Schedule = "string",
    StartAt = "string",
    Timeout = 0,
});

    example, err := hsdp.NewFunction(ctx, "functionResource", &hsdp.FunctionArgs{
	Backend: &hsdp.FunctionBackendArgs{
		Credentials: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	DockerImage: pulumi.String("string"),
	Commands: pulumi.StringArray{
		pulumi.String("string"),
	},
	DockerCredentials: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Environment: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FunctionId: pulumi.String("string"),
	Name:       pulumi.String("string"),
	RunEvery:   pulumi.String("string"),
	Schedule:   pulumi.String("string"),
	StartAt:    pulumi.String("string"),
	Timeout:    pulumi.Float64(0),
})

    var functionResource = new Function("functionResource", FunctionArgs.builder()
    .backend(FunctionBackendArgs.builder()
        .credentials(Map.of("string", "string"))
        .build())
    .dockerImage("string")
    .commands("string")
    .dockerCredentials(Map.of("string", "string"))
    .environment(Map.of("string", "string"))
    .functionId("string")
    .name("string")
    .runEvery("string")
    .schedule("string")
    .startAt("string")
    .timeout(0)
    .build());

    function_resource = hsdp.Function("functionResource",
    backend={
        "credentials": {
            "string": "string",
        },
    },
    docker_image="string",
    commands=["string"],
    docker_credentials={
        "string": "string",
    },
    environment={
        "string": "string",
    },
    function_id="string",
    name="string",
    run_every="string",
    schedule="string",
    start_at="string",
    timeout=0)

    const functionResource = new hsdp.Function("functionResource", {
    backend: {
        credentials: {
            string: "string",
        },
    },
    dockerImage: "string",
    commands: ["string"],
    dockerCredentials: {
        string: "string",
    },
    environment: {
        string: "string",
    },
    functionId: "string",
    name: "string",
    runEvery: "string",
    schedule: "string",
    startAt: "string",
    timeout: 0,
});

    type: hsdp:Function
properties:
    backend:
        credentials:
            string: string
    commands:
        - string
    dockerCredentials:
        string: string
    dockerImage: string
    environment:
        string: string
    functionId: string
    name: string
    runEvery: string
    schedule: string
    startAt: string
    timeout: 0

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

    Backend FunctionBackend
    Use this block to specify backend details
    DockerImage string
    The docker image that contains the logic of the function
    Commands List<string>
    The command to execute in the container. Default is /app/server
    DockerCredentials Dictionary<string, string>
    The docker registry credentials
    Environment Dictionary<string, string>
    The environment variables to set in the docker container before executing the function
    FunctionId string
    Name string
    The name of the function
    RunEvery string
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    Schedule string
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    StartAt string
    Timeout double
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    Backend FunctionBackendArgs
    Use this block to specify backend details
    DockerImage string
    The docker image that contains the logic of the function
    Commands []string
    The command to execute in the container. Default is /app/server
    DockerCredentials map[string]string
    The docker registry credentials
    Environment map[string]string
    The environment variables to set in the docker container before executing the function
    FunctionId string
    Name string
    The name of the function
    RunEvery string
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    Schedule string
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    StartAt string
    Timeout float64
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    backend FunctionBackend
    Use this block to specify backend details
    dockerImage String
    The docker image that contains the logic of the function
    commands List<String>
    The command to execute in the container. Default is /app/server
    dockerCredentials Map<String,String>
    The docker registry credentials
    environment Map<String,String>
    The environment variables to set in the docker container before executing the function
    functionId String
    name String
    The name of the function
    runEvery String
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule String
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    startAt String
    timeout Double
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    backend FunctionBackend
    Use this block to specify backend details
    dockerImage string
    The docker image that contains the logic of the function
    commands string[]
    The command to execute in the container. Default is /app/server
    dockerCredentials {[key: string]: string}
    The docker registry credentials
    environment {[key: string]: string}
    The environment variables to set in the docker container before executing the function
    functionId string
    name string
    The name of the function
    runEvery string
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule string
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    startAt string
    timeout number
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    backend FunctionBackendArgs
    Use this block to specify backend details
    docker_image str
    The docker image that contains the logic of the function
    commands Sequence[str]
    The command to execute in the container. Default is /app/server
    docker_credentials Mapping[str, str]
    The docker registry credentials
    environment Mapping[str, str]
    The environment variables to set in the docker container before executing the function
    function_id str
    name str
    The name of the function
    run_every str
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule str
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    start_at str
    timeout float
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    backend Property Map
    Use this block to specify backend details
    dockerImage String
    The docker image that contains the logic of the function
    commands List<String>
    The command to execute in the container. Default is /app/server
    dockerCredentials Map<String>
    The docker registry credentials
    environment Map<String>
    The environment variables to set in the docker container before executing the function
    functionId String
    name String
    The name of the function
    runEvery String
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule String
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    startAt String
    timeout Number
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)

    Outputs

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

    AsyncEndpoint string
    The gateway endpoint where you can schedule the function asynchronously
    AuthType string
    The authentication type. Possible values [none, token, iam]
    Endpoint string
    The gateway endpoint where you can trigger this function
    Id string
    The provider-assigned unique ID for this managed resource.
    SyncEndpoint string
    Token string
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    AsyncEndpoint string
    The gateway endpoint where you can schedule the function asynchronously
    AuthType string
    The authentication type. Possible values [none, token, iam]
    Endpoint string
    The gateway endpoint where you can trigger this function
    Id string
    The provider-assigned unique ID for this managed resource.
    SyncEndpoint string
    Token string
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    asyncEndpoint String
    The gateway endpoint where you can schedule the function asynchronously
    authType String
    The authentication type. Possible values [none, token, iam]
    endpoint String
    The gateway endpoint where you can trigger this function
    id String
    The provider-assigned unique ID for this managed resource.
    syncEndpoint String
    token String
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    asyncEndpoint string
    The gateway endpoint where you can schedule the function asynchronously
    authType string
    The authentication type. Possible values [none, token, iam]
    endpoint string
    The gateway endpoint where you can trigger this function
    id string
    The provider-assigned unique ID for this managed resource.
    syncEndpoint string
    token string
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    async_endpoint str
    The gateway endpoint where you can schedule the function asynchronously
    auth_type str
    The authentication type. Possible values [none, token, iam]
    endpoint str
    The gateway endpoint where you can trigger this function
    id str
    The provider-assigned unique ID for this managed resource.
    sync_endpoint str
    token str
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    asyncEndpoint String
    The gateway endpoint where you can schedule the function asynchronously
    authType String
    The authentication type. Possible values [none, token, iam]
    endpoint String
    The gateway endpoint where you can trigger this function
    id String
    The provider-assigned unique ID for this managed resource.
    syncEndpoint String
    token String
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE

    Look up Existing Function Resource

    Get an existing Function 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?: FunctionState, opts?: CustomResourceOptions): Function
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        async_endpoint: Optional[str] = None,
        auth_type: Optional[str] = None,
        backend: Optional[FunctionBackendArgs] = None,
        commands: Optional[Sequence[str]] = None,
        docker_credentials: Optional[Mapping[str, str]] = None,
        docker_image: Optional[str] = None,
        endpoint: Optional[str] = None,
        environment: Optional[Mapping[str, str]] = None,
        function_id: Optional[str] = None,
        name: Optional[str] = None,
        run_every: Optional[str] = None,
        schedule: Optional[str] = None,
        start_at: Optional[str] = None,
        sync_endpoint: Optional[str] = None,
        timeout: Optional[float] = None,
        token: Optional[str] = None) -> Function
    func GetFunction(ctx *Context, name string, id IDInput, state *FunctionState, opts ...ResourceOption) (*Function, error)
    public static Function Get(string name, Input<string> id, FunctionState? state, CustomResourceOptions? opts = null)
    public static Function get(String name, Output<String> id, FunctionState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:Function    get:      id: ${id}
    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:
    AsyncEndpoint string
    The gateway endpoint where you can schedule the function asynchronously
    AuthType string
    The authentication type. Possible values [none, token, iam]
    Backend FunctionBackend
    Use this block to specify backend details
    Commands List<string>
    The command to execute in the container. Default is /app/server
    DockerCredentials Dictionary<string, string>
    The docker registry credentials
    DockerImage string
    The docker image that contains the logic of the function
    Endpoint string
    The gateway endpoint where you can trigger this function
    Environment Dictionary<string, string>
    The environment variables to set in the docker container before executing the function
    FunctionId string
    Name string
    The name of the function
    RunEvery string
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    Schedule string
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    StartAt string
    SyncEndpoint string
    Timeout double
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    Token string
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    AsyncEndpoint string
    The gateway endpoint where you can schedule the function asynchronously
    AuthType string
    The authentication type. Possible values [none, token, iam]
    Backend FunctionBackendArgs
    Use this block to specify backend details
    Commands []string
    The command to execute in the container. Default is /app/server
    DockerCredentials map[string]string
    The docker registry credentials
    DockerImage string
    The docker image that contains the logic of the function
    Endpoint string
    The gateway endpoint where you can trigger this function
    Environment map[string]string
    The environment variables to set in the docker container before executing the function
    FunctionId string
    Name string
    The name of the function
    RunEvery string
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    Schedule string
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    StartAt string
    SyncEndpoint string
    Timeout float64
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    Token string
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    asyncEndpoint String
    The gateway endpoint where you can schedule the function asynchronously
    authType String
    The authentication type. Possible values [none, token, iam]
    backend FunctionBackend
    Use this block to specify backend details
    commands List<String>
    The command to execute in the container. Default is /app/server
    dockerCredentials Map<String,String>
    The docker registry credentials
    dockerImage String
    The docker image that contains the logic of the function
    endpoint String
    The gateway endpoint where you can trigger this function
    environment Map<String,String>
    The environment variables to set in the docker container before executing the function
    functionId String
    name String
    The name of the function
    runEvery String
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule String
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    startAt String
    syncEndpoint String
    timeout Double
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    token String
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    asyncEndpoint string
    The gateway endpoint where you can schedule the function asynchronously
    authType string
    The authentication type. Possible values [none, token, iam]
    backend FunctionBackend
    Use this block to specify backend details
    commands string[]
    The command to execute in the container. Default is /app/server
    dockerCredentials {[key: string]: string}
    The docker registry credentials
    dockerImage string
    The docker image that contains the logic of the function
    endpoint string
    The gateway endpoint where you can trigger this function
    environment {[key: string]: string}
    The environment variables to set in the docker container before executing the function
    functionId string
    name string
    The name of the function
    runEvery string
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule string
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    startAt string
    syncEndpoint string
    timeout number
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    token string
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    async_endpoint str
    The gateway endpoint where you can schedule the function asynchronously
    auth_type str
    The authentication type. Possible values [none, token, iam]
    backend FunctionBackendArgs
    Use this block to specify backend details
    commands Sequence[str]
    The command to execute in the container. Default is /app/server
    docker_credentials Mapping[str, str]
    The docker registry credentials
    docker_image str
    The docker image that contains the logic of the function
    endpoint str
    The gateway endpoint where you can trigger this function
    environment Mapping[str, str]
    The environment variables to set in the docker container before executing the function
    function_id str
    name str
    The name of the function
    run_every str
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule str
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    start_at str
    sync_endpoint str
    timeout float
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    token str
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE
    asyncEndpoint String
    The gateway endpoint where you can schedule the function asynchronously
    authType String
    The authentication type. Possible values [none, token, iam]
    backend Property Map
    Use this block to specify backend details
    commands List<String>
    The command to execute in the container. Default is /app/server
    dockerCredentials Map<String>
    The docker registry credentials
    dockerImage String
    The docker image that contains the logic of the function
    endpoint String
    The gateway endpoint where you can trigger this function
    environment Map<String>
    The environment variables to set in the docker container before executing the function
    functionId String
    name String
    The name of the function
    runEvery String
    Run the function every {value}{unit} period. Supported units are s, m, h, d for second, minute, hours, days respectively. Conflicts with cron Example: a value of "20m" would run the function every 20 minutes.
    schedule String
    set schedule using cron format. This requires a backend with activated gateway. Conflicts with run_every
    startAt String
    syncEndpoint String
    timeout Number
    When set, limits the execution time (seconds) to this value. Default: 1800 (30 minutes)
    token String
    The token to use in case auth_type is set to token. This token must be pasted in the HTTP Authorization header as Token TOKENHERE

    Supporting Types

    FunctionBackend, FunctionBackendArgs

    Credentials Dictionary<string, string>
    The backend credentials. Must be iron configuration details at this time.
    Credentials map[string]string
    The backend credentials. Must be iron configuration details at this time.
    credentials Map<String,String>
    The backend credentials. Must be iron configuration details at this time.
    credentials {[key: string]: string}
    The backend credentials. Must be iron configuration details at this time.
    credentials Mapping[str, str]
    The backend credentials. Must be iron configuration details at this time.
    credentials Map<String>
    The backend credentials. Must be iron configuration details at this time.

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
    philips-software/terraform-provider-hsdp