Skip to content

FunctionInvokerProps

Properties for defining a FunctionInvoker.

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

Initializer

import ros_cdk_fc
ros_cdk_fc.FunctionInvokerProps(
  function_name: typing.Union[str, IResolvable],
  service_name: typing.Union[str, IResolvable],
  async: typing.Union[bool, IResolvable] = None,
  check_error: typing.Union[bool, IResolvable] = None,
  event: typing.Union[str, IResolvable] = None,
  execute_version: typing.Union[typing.Union[int, float], IResolvable] = None,
  qualifier: typing.Union[str, IResolvable] = None,
  service_region_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
function_name typing.Union[str, ros_cdk_core.IResolvable] Property functionName: Function name.
service_name typing.Union[str, ros_cdk_core.IResolvable] Property serviceName: Service name.
async typing.Union[bool, ros_cdk_core.IResolvable] Property async: Invocation type, Sync or Async.
check_error typing.Union[bool, ros_cdk_core.IResolvable] Property checkError: Whether check error for function invocation result.
event typing.Union[str, 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.
execute_version typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property executeVersion: If the property is not specified for creation and update, the function will not be invoked.
qualifier typing.Union[str, ros_cdk_core.IResolvable] Property qualifier: service version, can be versionId or aliasName.
service_region_id typing.Union[str, ros_cdk_core.IResolvable] Property serviceRegionId: Which region service belongs to.

function_nameRequired

function_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property functionName: Function name.


service_nameRequired

service_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property serviceName: Service name.


asyncOptional

async: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property async: Invocation type, Sync or Async.

Defaults to Sync.


check_errorOptional

check_error: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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

event: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


execute_versionOptional

execute_version: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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

qualifier: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


service_region_idOptional

service_region_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property serviceRegionId: Which region service belongs to.