FunctionInvoker

• Implements: IFunctionInvoker

This class encapsulates and extends the ROS resource type ALIYUN::FC::FunctionInvoker.

Initializers

import ros_cdk_fc
ros_cdk_fc.FunctionInvoker(
  scope: Construct,
  id: str,
  function_name: typing.Union[str, IResolvable],
  service_name: typing.Union[str, IResolvable],
  async: typing.Union[bool, IResolvable] = None,
  check_async_invocation: typing.Union[IResolvable, CheckAsyncInvocationProperty] = 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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

function_name^Required

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

Property functionName: Function name.

service_name^Required

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

Property serviceName: Service name.

async^Optional

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

Property async: Invocation type, Sync or Async.

Defaults to Sync.

check_async_invocation^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, CheckAsyncInvocationProperty]

Property checkAsyncInvocation: Check async invocation setting.

check_error^Optional

• 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

event^Optional

• 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_version^Optional

• 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.

qualifier^Optional

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

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

service_region_id^Optional

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

Property serviceRegionId: Which region service belongs to.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_fc
ros_cdk_fc.FunctionInvoker.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_result^Required

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_type^Required

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.

props^Required

props: FunctionInvokerProps

• Type: FunctionInvokerProps