FunctionInvoker

• Implements: IFunctionInvoker

This class encapsulates and extends the ROS resource type ALIYUN::FC::FunctionInvokerInvokes a Function Compute 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)
//  .checkAsyncInvocation(IResolvable)
//  .checkAsyncInvocation(CheckAsyncInvocationProperty)
//  .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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

functionName^Required

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

Property functionName: Function name.

serviceName^Required

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

Property serviceName: Service name.

async^Optional

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

Property async: Invocation type, Sync or Async.

Defaults to Sync.

checkAsyncInvocation^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR CheckAsyncInvocationProperty

Property checkAsyncInvocation: Check async invocation setting.

checkError^Optional

• 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

event^Optional

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

executeVersion^Optional

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

qualifier^Optional

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

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

serviceRegionId^Optional

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

Property serviceRegionId: Which region service belongs to.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrResult^Required

public java.lang.Object getAttrResult();

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

attrResultType^Required

public java.lang.Object getAttrResultType();

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

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

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

props^Required

public FunctionInvokerProps getProps();

• Type: FunctionInvokerProps