Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.19.0 published on Friday, Mar 18, 2022 by Pulumi

Function

Import

Function Compute function can be imported using the id, e.g.

 $ pulumi import alicloud:fc/function:Function foo my-fc-service:hello-world

Create a Function Resource

new Function(name: string, args: FunctionArgs, opts?: CustomResourceOptions);
@overload
def Function(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ca_port: Optional[int] = None,
             code_checksum: Optional[str] = None,
             custom_container_config: Optional[FunctionCustomContainerConfigArgs] = None,
             description: Optional[str] = None,
             environment_variables: Optional[Mapping[str, Any]] = None,
             filename: Optional[str] = None,
             handler: Optional[str] = None,
             initialization_timeout: Optional[int] = None,
             initializer: Optional[str] = None,
             instance_concurrency: Optional[int] = None,
             instance_type: Optional[str] = None,
             memory_size: Optional[int] = None,
             name: Optional[str] = None,
             name_prefix: Optional[str] = None,
             oss_bucket: Optional[str] = None,
             oss_key: Optional[str] = None,
             runtime: Optional[str] = None,
             service: Optional[str] = None,
             timeout: Optional[int] = None)
@overload
def Function(resource_name: str,
             args: FunctionArgs,
             opts: Optional[ResourceOptions] = 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: alicloud:fc:Function
properties: # The arguments to resource properties.
options: # 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.
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.

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

The Function resource accepts the following input properties:

Handler string

The function entry point in your code.

Runtime string

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

Service string

The Function Compute service name.

CaPort int

The port that the function listen to, only valid for custom runtime and custom container runtime.

CodeChecksum string

The checksum (crc64) of the function code.

CustomContainerConfig Pulumi.AliCloud.FC.Inputs.FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

Description string

The Function Compute function description.

EnvironmentVariables Dictionary<string, object>

A map that defines environment variables for the function.

Filename string

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

InitializationTimeout int

The maximum length of time, in seconds, that the function's initialization should be run for.

Initializer string

The entry point of the function's initialization.

InstanceConcurrency int

The maximum number of requests can be executed concurrently within the single function instance.

InstanceType string

The instance type of the function.

MemorySize int

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

Name string

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

NamePrefix string

Setting a prefix to get a only function name. It is conflict with "name".

OssBucket string

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

OssKey string

The OSS key of an object containing the function's deployment package. Conflicts with filename.

Timeout int

The amount of time your function has to run in seconds.

Handler string

The function entry point in your code.

Runtime string

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

Service string

The Function Compute service name.

CaPort int

The port that the function listen to, only valid for custom runtime and custom container runtime.

CodeChecksum string

The checksum (crc64) of the function code.

CustomContainerConfig FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

Description string

The Function Compute function description.

EnvironmentVariables map[string]interface{}

A map that defines environment variables for the function.

Filename string

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

InitializationTimeout int

The maximum length of time, in seconds, that the function's initialization should be run for.

Initializer string

The entry point of the function's initialization.

InstanceConcurrency int

The maximum number of requests can be executed concurrently within the single function instance.

InstanceType string

The instance type of the function.

MemorySize int

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

Name string

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

NamePrefix string

Setting a prefix to get a only function name. It is conflict with "name".

OssBucket string

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

OssKey string

The OSS key of an object containing the function's deployment package. Conflicts with filename.

Timeout int

The amount of time your function has to run in seconds.

handler String

The function entry point in your code.

runtime String

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service String

The Function Compute service name.

caPort Integer

The port that the function listen to, only valid for custom runtime and custom container runtime.

codeChecksum String

The checksum (crc64) of the function code.

customContainerConfig FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

description String

The Function Compute function description.

environmentVariables Map<String,Object>

A map that defines environment variables for the function.

filename String

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

initializationTimeout Integer

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer String

The entry point of the function's initialization.

instanceConcurrency Integer

The maximum number of requests can be executed concurrently within the single function instance.

instanceType String

The instance type of the function.

memorySize Integer

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name String

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

namePrefix String

Setting a prefix to get a only function name. It is conflict with "name".

ossBucket String

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

ossKey String

The OSS key of an object containing the function's deployment package. Conflicts with filename.

timeout Integer

The amount of time your function has to run in seconds.

handler string

The function entry point in your code.

runtime string

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service string

The Function Compute service name.

caPort number

The port that the function listen to, only valid for custom runtime and custom container runtime.

codeChecksum string

The checksum (crc64) of the function code.

customContainerConfig FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

description string

The Function Compute function description.

environmentVariables {[key: string]: any}

A map that defines environment variables for the function.

filename string

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

initializationTimeout number

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer string

The entry point of the function's initialization.

instanceConcurrency number

The maximum number of requests can be executed concurrently within the single function instance.

instanceType string

The instance type of the function.

memorySize number

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name string

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

namePrefix string

Setting a prefix to get a only function name. It is conflict with "name".

ossBucket string

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

ossKey string

The OSS key of an object containing the function's deployment package. Conflicts with filename.

timeout number

The amount of time your function has to run in seconds.

handler str

The function entry point in your code.

runtime str

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service str

The Function Compute service name.

ca_port int

The port that the function listen to, only valid for custom runtime and custom container runtime.

code_checksum str

The checksum (crc64) of the function code.

custom_container_config FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

description str

The Function Compute function description.

environment_variables Mapping[str, Any]

A map that defines environment variables for the function.

filename str

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

initialization_timeout int

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer str

The entry point of the function's initialization.

instance_concurrency int

The maximum number of requests can be executed concurrently within the single function instance.

instance_type str

The instance type of the function.

memory_size int

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name str

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

name_prefix str

Setting a prefix to get a only function name. It is conflict with "name".

oss_bucket str

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

oss_key str

The OSS key of an object containing the function's deployment package. Conflicts with filename.

timeout int

The amount of time your function has to run in seconds.

handler String

The function entry point in your code.

runtime String

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service String

The Function Compute service name.

caPort Number

The port that the function listen to, only valid for custom runtime and custom container runtime.

codeChecksum String

The checksum (crc64) of the function code.

customContainerConfig Property Map

The configuration for custom container runtime.

description String

The Function Compute function description.

environmentVariables Map<Any>

A map that defines environment variables for the function.

filename String

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

initializationTimeout Number

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer String

The entry point of the function's initialization.

instanceConcurrency Number

The maximum number of requests can be executed concurrently within the single function instance.

instanceType String

The instance type of the function.

memorySize Number

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name String

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

namePrefix String

Setting a prefix to get a only function name. It is conflict with "name".

ossBucket String

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

ossKey String

The OSS key of an object containing the function's deployment package. Conflicts with filename.

timeout Number

The amount of time your function has to run in seconds.

Outputs

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

FunctionId string

The Function Compute service ID.

Id string

The provider-assigned unique ID for this managed resource.

LastModified string

The date this resource was last modified.

FunctionId string

The Function Compute service ID.

Id string

The provider-assigned unique ID for this managed resource.

LastModified string

The date this resource was last modified.

functionId String

The Function Compute service ID.

id String

The provider-assigned unique ID for this managed resource.

lastModified String

The date this resource was last modified.

functionId string

The Function Compute service ID.

id string

The provider-assigned unique ID for this managed resource.

lastModified string

The date this resource was last modified.

function_id str

The Function Compute service ID.

id str

The provider-assigned unique ID for this managed resource.

last_modified str

The date this resource was last modified.

functionId String

The Function Compute service ID.

id String

The provider-assigned unique ID for this managed resource.

lastModified String

The date this resource was last modified.

Look up an 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,
        ca_port: Optional[int] = None,
        code_checksum: Optional[str] = None,
        custom_container_config: Optional[FunctionCustomContainerConfigArgs] = None,
        description: Optional[str] = None,
        environment_variables: Optional[Mapping[str, Any]] = None,
        filename: Optional[str] = None,
        function_id: Optional[str] = None,
        handler: Optional[str] = None,
        initialization_timeout: Optional[int] = None,
        initializer: Optional[str] = None,
        instance_concurrency: Optional[int] = None,
        instance_type: Optional[str] = None,
        last_modified: Optional[str] = None,
        memory_size: Optional[int] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        oss_bucket: Optional[str] = None,
        oss_key: Optional[str] = None,
        runtime: Optional[str] = None,
        service: Optional[str] = None,
        timeout: Optional[int] = 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)
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:
CaPort int

The port that the function listen to, only valid for custom runtime and custom container runtime.

CodeChecksum string

The checksum (crc64) of the function code.

CustomContainerConfig Pulumi.AliCloud.FC.Inputs.FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

Description string

The Function Compute function description.

EnvironmentVariables Dictionary<string, object>

A map that defines environment variables for the function.

Filename string

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

FunctionId string

The Function Compute service ID.

Handler string

The function entry point in your code.

InitializationTimeout int

The maximum length of time, in seconds, that the function's initialization should be run for.

Initializer string

The entry point of the function's initialization.

InstanceConcurrency int

The maximum number of requests can be executed concurrently within the single function instance.

InstanceType string

The instance type of the function.

LastModified string

The date this resource was last modified.

MemorySize int

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

Name string

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

NamePrefix string

Setting a prefix to get a only function name. It is conflict with "name".

OssBucket string

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

OssKey string

The OSS key of an object containing the function's deployment package. Conflicts with filename.

Runtime string

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

Service string

The Function Compute service name.

Timeout int

The amount of time your function has to run in seconds.

CaPort int

The port that the function listen to, only valid for custom runtime and custom container runtime.

CodeChecksum string

The checksum (crc64) of the function code.

CustomContainerConfig FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

Description string

The Function Compute function description.

EnvironmentVariables map[string]interface{}

A map that defines environment variables for the function.

Filename string

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

FunctionId string

The Function Compute service ID.

Handler string

The function entry point in your code.

InitializationTimeout int

The maximum length of time, in seconds, that the function's initialization should be run for.

Initializer string

The entry point of the function's initialization.

InstanceConcurrency int

The maximum number of requests can be executed concurrently within the single function instance.

InstanceType string

The instance type of the function.

LastModified string

The date this resource was last modified.

MemorySize int

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

Name string

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

NamePrefix string

Setting a prefix to get a only function name. It is conflict with "name".

OssBucket string

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

OssKey string

The OSS key of an object containing the function's deployment package. Conflicts with filename.

Runtime string

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

Service string

The Function Compute service name.

Timeout int

The amount of time your function has to run in seconds.

caPort Integer

The port that the function listen to, only valid for custom runtime and custom container runtime.

codeChecksum String

The checksum (crc64) of the function code.

customContainerConfig FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

description String

The Function Compute function description.

environmentVariables Map<String,Object>

A map that defines environment variables for the function.

filename String

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

functionId String

The Function Compute service ID.

handler String

The function entry point in your code.

initializationTimeout Integer

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer String

The entry point of the function's initialization.

instanceConcurrency Integer

The maximum number of requests can be executed concurrently within the single function instance.

instanceType String

The instance type of the function.

lastModified String

The date this resource was last modified.

memorySize Integer

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name String

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

namePrefix String

Setting a prefix to get a only function name. It is conflict with "name".

ossBucket String

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

ossKey String

The OSS key of an object containing the function's deployment package. Conflicts with filename.

runtime String

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service String

The Function Compute service name.

timeout Integer

The amount of time your function has to run in seconds.

caPort number

The port that the function listen to, only valid for custom runtime and custom container runtime.

codeChecksum string

The checksum (crc64) of the function code.

customContainerConfig FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

description string

The Function Compute function description.

environmentVariables {[key: string]: any}

A map that defines environment variables for the function.

filename string

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

functionId string

The Function Compute service ID.

handler string

The function entry point in your code.

initializationTimeout number

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer string

The entry point of the function's initialization.

instanceConcurrency number

The maximum number of requests can be executed concurrently within the single function instance.

instanceType string

The instance type of the function.

lastModified string

The date this resource was last modified.

memorySize number

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name string

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

namePrefix string

Setting a prefix to get a only function name. It is conflict with "name".

ossBucket string

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

ossKey string

The OSS key of an object containing the function's deployment package. Conflicts with filename.

runtime string

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service string

The Function Compute service name.

timeout number

The amount of time your function has to run in seconds.

ca_port int

The port that the function listen to, only valid for custom runtime and custom container runtime.

code_checksum str

The checksum (crc64) of the function code.

custom_container_config FunctionCustomContainerConfigArgs

The configuration for custom container runtime.

description str

The Function Compute function description.

environment_variables Mapping[str, Any]

A map that defines environment variables for the function.

filename str

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

function_id str

The Function Compute service ID.

handler str

The function entry point in your code.

initialization_timeout int

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer str

The entry point of the function's initialization.

instance_concurrency int

The maximum number of requests can be executed concurrently within the single function instance.

instance_type str

The instance type of the function.

last_modified str

The date this resource was last modified.

memory_size int

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name str

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

name_prefix str

Setting a prefix to get a only function name. It is conflict with "name".

oss_bucket str

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

oss_key str

The OSS key of an object containing the function's deployment package. Conflicts with filename.

runtime str

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service str

The Function Compute service name.

timeout int

The amount of time your function has to run in seconds.

caPort Number

The port that the function listen to, only valid for custom runtime and custom container runtime.

codeChecksum String

The checksum (crc64) of the function code.

customContainerConfig Property Map

The configuration for custom container runtime.

description String

The Function Compute function description.

environmentVariables Map<Any>

A map that defines environment variables for the function.

filename String

The path to the function's deployment package within the local filesystem. It is conflict with the oss_-prefixed options.

functionId String

The Function Compute service ID.

handler String

The function entry point in your code.

initializationTimeout Number

The maximum length of time, in seconds, that the function's initialization should be run for.

initializer String

The entry point of the function's initialization.

instanceConcurrency Number

The maximum number of requests can be executed concurrently within the single function instance.

instanceType String

The instance type of the function.

lastModified String

The date this resource was last modified.

memorySize Number

Amount of memory in MB your function can use at runtime. Defaults to 128. Limits to [128, 32768].

name String

The Function Compute function name. It is the only in one service and is conflict with "name_prefix".

namePrefix String

Setting a prefix to get a only function name. It is conflict with "name".

ossBucket String

The OSS bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same Alibaba Cloud region where you are creating the function.

ossKey String

The OSS key of an object containing the function's deployment package. Conflicts with filename.

runtime String

See [Runtimes][https://www.alibabacloud.com/help/doc-detail/52077.htm] for valid values.

service String

The Function Compute service name.

timeout Number

The amount of time your function has to run in seconds.

Supporting Types

FunctionCustomContainerConfig

Image string

The container image address.

Args string

The args field specifies the arguments passed to the command.

Command string

The entry point of the container, which specifies the actual command run by the container.

Image string

The container image address.

Args string

The args field specifies the arguments passed to the command.

Command string

The entry point of the container, which specifies the actual command run by the container.

image String

The container image address.

args String

The args field specifies the arguments passed to the command.

command String

The entry point of the container, which specifies the actual command run by the container.

image string

The container image address.

args string

The args field specifies the arguments passed to the command.

command string

The entry point of the container, which specifies the actual command run by the container.

image str

The container image address.

args str

The args field specifies the arguments passed to the command.

command str

The entry point of the container, which specifies the actual command run by the container.

image String

The container image address.

args String

The args field specifies the arguments passed to the command.

command String

The entry point of the container, which specifies the actual command run by the container.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.