Skip to content

IFunctionInvoker

Represents a FunctionInvoker.

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node for this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
attrEvents string | @alicloud/ros-cdk-core.IResolvable Attribute Events: Events for async invocation.
attrResult string | @alicloud/ros-cdk-core.IResolvable Attribute Result: Depends on result type: NoResult: Async invoke has no result.
attrResultType string | @alicloud/ros-cdk-core.IResolvable Attribute ResultType: Result type: NoResult: Async invoke has no result.
attrTaskId string | @alicloud/ros-cdk-core.IResolvable Attribute TaskId: Task id for async invocation.
props FunctionInvokerProps No description.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node for this construct.

envRequired 

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

attrEventsRequired 

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

Attribute Events: Events for async invocation.

attrResultRequired 

public readonly attrResult: string | IResolvable;
  • Type: string | @alicloud/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.

attrResultTypeRequired 

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

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

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

attrTaskIdRequired 

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

Attribute TaskId: Task id for async invocation.

propsRequired 

public readonly props: FunctionInvokerProps;