Skip to content

FunctionInvokerProps

Properties for defining a FunctionInvoker.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fc3-functioninvoker

Initializer 

import { FunctionInvokerProps } from '@alicloud/ros-cdk-fc3'
const functionInvokerProps: FunctionInvokerProps = { ... }

Properties

Name Type Description
functionName string | @alicloud/ros-cdk-core.IResolvable Property functionName: The name of the function.
async boolean | @alicloud/ros-cdk-core.IResolvable Property async: Whether to invoke the function asynchronously.
checkAsyncInvocation @alicloud/ros-cdk-core.IResolvable | CheckAsyncInvocationProperty Property checkAsyncInvocation: Check async invocation setting.
checkError boolean | @alicloud/ros-cdk-core.IResolvable Property checkError: Whether check error for function invocation result.
event string | @alicloud/ros-cdk-core.IResolvable Property event: This value is passed to function as utf-8 encoded string.It’s function’s responsibility to interpret the value. If the value needs to be binary, encode it via base64 before passing to this property.
executeVersion number | @alicloud/ros-cdk-core.IResolvable Property executeVersion: If the property is not specified for creation and update, the function will not be invoked.
qualifier string | @alicloud/ros-cdk-core.IResolvable Property qualifier: service version, can be versionId or aliasName.
serviceRegionId string | @alicloud/ros-cdk-core.IResolvable Property serviceRegionId: Which region service belongs to.

functionNameRequired 

public readonly functionName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property functionName: The name of the function.

asyncOptional 

public readonly async: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property async: Whether to invoke the function asynchronously.

checkAsyncInvocationOptional 

public readonly checkAsyncInvocation: IResolvable | CheckAsyncInvocationProperty;

Property checkAsyncInvocation: Check async invocation setting.

checkErrorOptional 

public readonly checkError: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property checkError: Whether check error for function invocation result.

If set true and function invocation result has error, the resource creation will be regard as failed. Default is false

eventOptional 

public readonly event: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property event: This value is passed to function as utf-8 encoded string.It’s function’s responsibility to interpret the value. If the value needs to be binary, encode it via base64 before passing to this property.

executeVersionOptional 

public readonly executeVersion: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property executeVersion: If the property is not specified for creation and update, the function will not be invoked.

The change of the property leads to the invoke of the function.

qualifierOptional 

public readonly qualifier: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property qualifier: service version, can be versionId or aliasName.

serviceRegionIdOptional 

public readonly serviceRegionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property serviceRegionId: Which region service belongs to.