Skip to content

IFunctionInvoker

Represents a FunctionInvoker.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_events typing.Union[str, ros_cdk_core.IResolvable] Attribute Events: Events for async invocation.
attr_result typing.Union[str, ros_cdk_core.IResolvable] Attribute Result: Depends on result type: NoResult: Async invoke has no result.
attr_result_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ResultType: Result type: NoResult: Async invoke has no result.
attr_task_id typing.Union[str, ros_cdk_core.IResolvable] Attribute TaskId: Task id for async invocation.
props FunctionInvokerProps No description.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.

envRequired 

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

attr_eventsRequired 

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

Attribute Events: Events for async invocation.

attr_resultRequired 

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

Attribute Result: Depends on result type: NoResult: Async invoke has no result.

Success: The response of the function. The response should be utf-8 encoded string, otherwise ROS will report an error. If the response is binary, encode it via base64 before it is returned. Failure: Error Message.

attr_result_typeRequired 

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

Attribute ResultType: Result type: NoResult: Async invoke has no result.

Success: Sync invoke succeeds. Failure: Sync invoke fails.

attr_task_idRequired 

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

Attribute TaskId: Task id for async invocation.

propsRequired 

props: FunctionInvokerProps