Skip to content

Trigger

This class encapsulates and extends the ROS resource type ALIYUN::FC::Trigger, which is used to trigger the invocation of a function.

Initializers 

import com.aliyun.ros.cdk.fc.Trigger;
Trigger.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .functionName(java.lang.String)
    .functionName(IResolvable)
    .serviceName(java.lang.String)
    .serviceName(IResolvable)
    .triggerConfig(IResolvable)
    .triggerConfig(java.util.Map<java.lang.String, java.lang.Object>)
    .triggerName(java.lang.String)
    .triggerName(IResolvable)
    .triggerType(java.lang.String)
    .triggerType(IResolvable)
//  .invocationRole(java.lang.String)
//  .invocationRole(IResolvable)
//  .qualifier(java.lang.String)
//  .qualifier(IResolvable)
//  .sourceArn(java.lang.String)
//  .sourceArn(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.
triggerConfig com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property triggerConfig: Event source specific trigger configuration.
triggerName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property triggerName: Trigger name.
triggerType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property triggerType: Trigger type, e.g. oss, timer, logs. This determines how the trigger config is interpreted. Example : "oss".
invocationRole java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property invocationRole: The role grants event source the permission to run function on behalf of user.
qualifier java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property qualifier: service version or alias.
sourceArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceArn: The Aliyun Resource Name (ARN) of event source.

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.

triggerConfigRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property triggerConfig: Event source specific trigger configuration.

The value is different according to trigger type.

triggerNameRequired

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

Property triggerName: Trigger name.

Example : "image_resize"

triggerTypeRequired

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

Property triggerType: Trigger type, e.g. oss, timer, logs. This determines how the trigger config is interpreted. Example : "oss".

invocationRoleOptional

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

Property invocationRole: The role grants event source the permission to run function on behalf of user.

This is optional for some triggers. Example : "acs:ram::1234567890:role/fc-test"

qualifierOptional

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

Property qualifier: service version or alias.

Example : "LATEST"

sourceArnOptional

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

Property sourceArn: The Aliyun Resource Name (ARN) of event source.

This is optional for some triggers. Example : "acs:oss:cn-shanghai:12345:mybucket"

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.Trigger;
Trigger.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.
attrFunctionName com.aliyun.ros.cdk.core.IResolvable Attribute FunctionName: Function name.
attrServiceName com.aliyun.ros.cdk.core.IResolvable Attribute ServiceName: Service name.
attrTriggerId com.aliyun.ros.cdk.core.IResolvable Attribute TriggerId: The trigger ID.
attrTriggerName com.aliyun.ros.cdk.core.IResolvable Attribute TriggerName: Trigger name.
attrUrlInternet com.aliyun.ros.cdk.core.IResolvable Attribute UrlInternet: The public domain address.
attrUrlIntranet com.aliyun.ros.cdk.core.IResolvable Attribute UrlIntranet: The private endpoint.

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

attrFunctionNameRequired 

public IResolvable getAttrFunctionName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute FunctionName: Function name.

attrServiceNameRequired 

public IResolvable getAttrServiceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceName: Service name.

attrTriggerIdRequired 

public IResolvable getAttrTriggerId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TriggerId: The trigger ID.

attrTriggerNameRequired 

public IResolvable getAttrTriggerName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TriggerName: Trigger name.

attrUrlInternetRequired 

public IResolvable getAttrUrlInternet();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UrlInternet: The public domain address.

You can access HTTP triggers over the Internet by using HTTP or HTTPS.

attrUrlIntranetRequired 

public IResolvable getAttrUrlIntranet();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UrlIntranet: The private endpoint.

In a VPC, you can access HTTP triggers by using HTTP or HTTPS.