FunctionInvoker

This class encapsulates and extends the ROS resource type ALIYUN::FC::FunctionInvoker, which is used to invoke a function.

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_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
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

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_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

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

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

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_result	ros_cdk_core.IResolvable	Attribute Result: Depends on result type: NoResult: Async invoke has no result.
attr_result_type	ros_cdk_core.IResolvable	Attribute ResultType: Result type: NoResult: Async invoke has no result.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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: IResolvable

• Type: 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: IResolvable

• Type: ros_cdk_core.IResolvable

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

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

---