1. Packages
  2. Ibm Provider
  3. API Docs
  4. getFunctionAction
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getFunctionAction

Explore with Pulumi AI

Retrieve information about an action. Import the details of an existing IBM Cloud Functions action as a read-only data source.

Example Usage

The following example retrieves information about the myaction action.

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

const nodehello = ibm.getFunctionAction({
    name: "action-name",
    namespace: "function-namespace-name",
});
Copy
import pulumi
import pulumi_ibm as ibm

nodehello = ibm.get_function_action(name="action-name",
    namespace="function-namespace-name")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupFunctionAction(ctx, &ibm.LookupFunctionActionArgs{
			Name:      "action-name",
			Namespace: "function-namespace-name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var nodehello = Ibm.GetFunctionAction.Invoke(new()
    {
        Name = "action-name",
        Namespace = "function-namespace-name",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetFunctionActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var nodehello = IbmFunctions.getFunctionAction(GetFunctionActionArgs.builder()
            .name("action-name")
            .namespace("function-namespace-name")
            .build());

    }
}
Copy
variables:
  nodehello:
    fn::invoke:
      function: ibm:getFunctionAction
      arguments:
        name: action-name
        namespace: function-namespace-name
Copy

Using getFunctionAction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFunctionAction(args: GetFunctionActionArgs, opts?: InvokeOptions): Promise<GetFunctionActionResult>
function getFunctionActionOutput(args: GetFunctionActionOutputArgs, opts?: InvokeOptions): Output<GetFunctionActionResult>
Copy
def get_function_action(id: Optional[str] = None,
                        name: Optional[str] = None,
                        namespace: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetFunctionActionResult
def get_function_action_output(id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        namespace: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetFunctionActionResult]
Copy
func LookupFunctionAction(ctx *Context, args *LookupFunctionActionArgs, opts ...InvokeOption) (*LookupFunctionActionResult, error)
func LookupFunctionActionOutput(ctx *Context, args *LookupFunctionActionOutputArgs, opts ...InvokeOption) LookupFunctionActionResultOutput
Copy

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

public static class GetFunctionAction 
{
    public static Task<GetFunctionActionResult> InvokeAsync(GetFunctionActionArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionActionResult> Invoke(GetFunctionActionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFunctionActionResult> getFunctionAction(GetFunctionActionArgs args, InvokeOptions options)
public static Output<GetFunctionActionResult> getFunctionAction(GetFunctionActionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getFunctionAction:getFunctionAction
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the action.
Namespace This property is required. string
The name of the function namespace.
Id string
(String) The ID of the action.
Name This property is required. string
The name of the action.
Namespace This property is required. string
The name of the function namespace.
Id string
(String) The ID of the action.
name This property is required. String
The name of the action.
namespace This property is required. String
The name of the function namespace.
id String
(String) The ID of the action.
name This property is required. string
The name of the action.
namespace This property is required. string
The name of the function namespace.
id string
(String) The ID of the action.
name This property is required. str
The name of the action.
namespace This property is required. str
The name of the function namespace.
id str
(String) The ID of the action.
name This property is required. String
The name of the action.
namespace This property is required. String
The name of the function namespace.
id String
(String) The ID of the action.

getFunctionAction Result

The following output properties are available:

ActionId string
(String) Action ID.
Annotations string
(List) Annotations to describe the action, including those set by you or by IBM Cloud Functions.
Execs List<GetFunctionActionExec>
(List of Objects) A nested block to describe executable binaries.
Id string
(String) The ID of the action.
Limits List<GetFunctionActionLimit>
(List) A nested block to describe assigned
Name string
Namespace string
(String) The name of the function namespace.
Parameters string
(List) Parameters passed to the action when the action is invoked, including those set by you or by IBM Cloud Functions.
Publish bool
(Bool) Action visibility.
TargetEndpointUrl string
(String) Target endpoint URL of the action.
Version string
(String) The version of the action.
ActionId string
(String) Action ID.
Annotations string
(List) Annotations to describe the action, including those set by you or by IBM Cloud Functions.
Execs []GetFunctionActionExec
(List of Objects) A nested block to describe executable binaries.
Id string
(String) The ID of the action.
Limits []GetFunctionActionLimit
(List) A nested block to describe assigned
Name string
Namespace string
(String) The name of the function namespace.
Parameters string
(List) Parameters passed to the action when the action is invoked, including those set by you or by IBM Cloud Functions.
Publish bool
(Bool) Action visibility.
TargetEndpointUrl string
(String) Target endpoint URL of the action.
Version string
(String) The version of the action.
actionId String
(String) Action ID.
annotations String
(List) Annotations to describe the action, including those set by you or by IBM Cloud Functions.
execs List<GetFunctionActionExec>
(List of Objects) A nested block to describe executable binaries.
id String
(String) The ID of the action.
limits List<GetFunctionActionLimit>
(List) A nested block to describe assigned
name String
namespace String
(String) The name of the function namespace.
parameters String
(List) Parameters passed to the action when the action is invoked, including those set by you or by IBM Cloud Functions.
publish Boolean
(Bool) Action visibility.
targetEndpointUrl String
(String) Target endpoint URL of the action.
version String
(String) The version of the action.
actionId string
(String) Action ID.
annotations string
(List) Annotations to describe the action, including those set by you or by IBM Cloud Functions.
execs GetFunctionActionExec[]
(List of Objects) A nested block to describe executable binaries.
id string
(String) The ID of the action.
limits GetFunctionActionLimit[]
(List) A nested block to describe assigned
name string
namespace string
(String) The name of the function namespace.
parameters string
(List) Parameters passed to the action when the action is invoked, including those set by you or by IBM Cloud Functions.
publish boolean
(Bool) Action visibility.
targetEndpointUrl string
(String) Target endpoint URL of the action.
version string
(String) The version of the action.
action_id str
(String) Action ID.
annotations str
(List) Annotations to describe the action, including those set by you or by IBM Cloud Functions.
execs Sequence[GetFunctionActionExec]
(List of Objects) A nested block to describe executable binaries.
id str
(String) The ID of the action.
limits Sequence[GetFunctionActionLimit]
(List) A nested block to describe assigned
name str
namespace str
(String) The name of the function namespace.
parameters str
(List) Parameters passed to the action when the action is invoked, including those set by you or by IBM Cloud Functions.
publish bool
(Bool) Action visibility.
target_endpoint_url str
(String) Target endpoint URL of the action.
version str
(String) The version of the action.
actionId String
(String) Action ID.
annotations String
(List) Annotations to describe the action, including those set by you or by IBM Cloud Functions.
execs List<Property Map>
(List of Objects) A nested block to describe executable binaries.
id String
(String) The ID of the action.
limits List<Property Map>
(List) A nested block to describe assigned
name String
namespace String
(String) The name of the function namespace.
parameters String
(List) Parameters passed to the action when the action is invoked, including those set by you or by IBM Cloud Functions.
publish Boolean
(Bool) Action visibility.
targetEndpointUrl String
(String) Target endpoint URL of the action.
version String
(String) The version of the action.

Supporting Types

GetFunctionActionExec

Code This property is required. string
(String) When not using the blackbox executable, the code to execute.
Components This property is required. List<string>
(String) The list of fully qualified actions.
Image This property is required. string
(String) When using the blackbox executable, the name of the container image name.
Init This property is required. string
(String) When using nodejs, the optional reference to the compressed file.
Kind This property is required. string
(String) The type of action. Accepted values: nodejs, blackbox, swift, sequence.
Main This property is required. string
(String) The name of the action entry point (function or fully-qualified method name, when applicable).
Code This property is required. string
(String) When not using the blackbox executable, the code to execute.
Components This property is required. []string
(String) The list of fully qualified actions.
Image This property is required. string
(String) When using the blackbox executable, the name of the container image name.
Init This property is required. string
(String) When using nodejs, the optional reference to the compressed file.
Kind This property is required. string
(String) The type of action. Accepted values: nodejs, blackbox, swift, sequence.
Main This property is required. string
(String) The name of the action entry point (function or fully-qualified method name, when applicable).
code This property is required. String
(String) When not using the blackbox executable, the code to execute.
components This property is required. List<String>
(String) The list of fully qualified actions.
image This property is required. String
(String) When using the blackbox executable, the name of the container image name.
init This property is required. String
(String) When using nodejs, the optional reference to the compressed file.
kind This property is required. String
(String) The type of action. Accepted values: nodejs, blackbox, swift, sequence.
main This property is required. String
(String) The name of the action entry point (function or fully-qualified method name, when applicable).
code This property is required. string
(String) When not using the blackbox executable, the code to execute.
components This property is required. string[]
(String) The list of fully qualified actions.
image This property is required. string
(String) When using the blackbox executable, the name of the container image name.
init This property is required. string
(String) When using nodejs, the optional reference to the compressed file.
kind This property is required. string
(String) The type of action. Accepted values: nodejs, blackbox, swift, sequence.
main This property is required. string
(String) The name of the action entry point (function or fully-qualified method name, when applicable).
code This property is required. str
(String) When not using the blackbox executable, the code to execute.
components This property is required. Sequence[str]
(String) The list of fully qualified actions.
image This property is required. str
(String) When using the blackbox executable, the name of the container image name.
init This property is required. str
(String) When using nodejs, the optional reference to the compressed file.
kind This property is required. str
(String) The type of action. Accepted values: nodejs, blackbox, swift, sequence.
main This property is required. str
(String) The name of the action entry point (function or fully-qualified method name, when applicable).
code This property is required. String
(String) When not using the blackbox executable, the code to execute.
components This property is required. List<String>
(String) The list of fully qualified actions.
image This property is required. String
(String) When using the blackbox executable, the name of the container image name.
init This property is required. String
(String) When using nodejs, the optional reference to the compressed file.
kind This property is required. String
(String) The type of action. Accepted values: nodejs, blackbox, swift, sequence.
main This property is required. String
(String) The name of the action entry point (function or fully-qualified method name, when applicable).

GetFunctionActionLimit

LogSize This property is required. double
(Integer) The maximum log size for the action, specified in megabytes. Default value is 10.
Memory This property is required. double
(Integer) The maximum memory for the action, specified in megabytes. Default value is 256.
Timeout This property is required. double
(Integer) The timeout limit to terminate the action, specified in milliseconds. Default value is 60000.
LogSize This property is required. float64
(Integer) The maximum log size for the action, specified in megabytes. Default value is 10.
Memory This property is required. float64
(Integer) The maximum memory for the action, specified in megabytes. Default value is 256.
Timeout This property is required. float64
(Integer) The timeout limit to terminate the action, specified in milliseconds. Default value is 60000.
logSize This property is required. Double
(Integer) The maximum log size for the action, specified in megabytes. Default value is 10.
memory This property is required. Double
(Integer) The maximum memory for the action, specified in megabytes. Default value is 256.
timeout This property is required. Double
(Integer) The timeout limit to terminate the action, specified in milliseconds. Default value is 60000.
logSize This property is required. number
(Integer) The maximum log size for the action, specified in megabytes. Default value is 10.
memory This property is required. number
(Integer) The maximum memory for the action, specified in megabytes. Default value is 256.
timeout This property is required. number
(Integer) The timeout limit to terminate the action, specified in milliseconds. Default value is 60000.
log_size This property is required. float
(Integer) The maximum log size for the action, specified in megabytes. Default value is 10.
memory This property is required. float
(Integer) The maximum memory for the action, specified in megabytes. Default value is 256.
timeout This property is required. float
(Integer) The timeout limit to terminate the action, specified in milliseconds. Default value is 60000.
logSize This property is required. Number
(Integer) The maximum log size for the action, specified in megabytes. Default value is 10.
memory This property is required. Number
(Integer) The maximum memory for the action, specified in megabytes. Default value is 256.
timeout This property is required. Number
(Integer) The timeout limit to terminate the action, specified in milliseconds. Default value is 60000.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.