Skip to content

FunctionInvoker

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

Initializers 

import com.aliyun.ros.cdk.fc.FunctionInvoker;
FunctionInvoker.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .functionName(java.lang.String)
    .functionName(IResolvable)
    .serviceName(java.lang.String)
    .serviceName(IResolvable)
//  .async(java.lang.Boolean)
//  .async(IResolvable)
//  .checkError(java.lang.Boolean)
//  .checkError(IResolvable)
//  .event(java.lang.String)
//  .event(IResolvable)
//  .executeVersion(java.lang.Number)
//  .executeVersion(IResolvable)
//  .qualifier(java.lang.String)
//  .qualifier(IResolvable)
//  .serviceRegionId(java.lang.String)
//  .serviceRegionId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
functionName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property functionName: Function name.
serviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceName: Service name.
async java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property async: Invocation type, Sync or Async.
checkError java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property checkError: Whether check error for function invocation result.
event java.lang.String OR com.aliyun.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.
executeVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property executeVersion: If the property is not specified for creation and update, the function will not be invoked.
qualifier java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property qualifier: service version, can be versionId or aliasName.
serviceRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceRegionId: Which region service belongs to.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

functionNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property functionName: Function name.

serviceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property serviceName: Service name.

asyncOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property async: Invocation type, Sync or Async.

Defaults to Sync.

checkErrorOptional

  • Type: java.lang.Boolean OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.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.

executeVersionOptional

  • Type: java.lang.Number OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

serviceRegionIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property serviceRegionId: Which region service belongs to.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.fc.FunctionInvoker;
FunctionInvoker.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrResult com.aliyun.ros.cdk.core.IResolvable Attribute Result: Depends on result type: NoResult: Async invoke has no result.
attrResultType com.aliyun.ros.cdk.core.IResolvable Attribute ResultType: Result type: NoResult: Async invoke has no result.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrResultRequired 

public IResolvable getAttrResult();
  • Type: com.aliyun.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 IResolvable getAttrResultType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

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