Function

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

Functions must be associated with services. All functions of a service share the same attributes as the service, such as service authorization and log configurations.

Initializers

import { Function } from '@alicloud/ros-cdk-fc'
new Function(scope: Construct, id: string, props: FunctionProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	FunctionProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: FunctionProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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.
codeFromAsset	Loads the fcFunction code from a local disk path.
codeFromBucket	Function handler code as an OSS object.
codeFromInline	Inline code for FC fcFunction handler.

---

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

codeFromAsset

public codeFromAsset(path: string): void

Loads the fcFunction code from a local disk path.

path^Required

• Type: string

Either a directory with the Lambda code bundle or a .zip file.

---

codeFromBucket

public codeFromBucket(bucket: Bucket, key: string): void

Function handler code as an OSS object.

bucket^Required

• Type: @alicloud/ros-cdk-oss.Bucket

The OSS bucket.

---

key^Required

• Type: string

The object key.

---

codeFromInline

public codeFromInline(code: string): void

Inline code for FC fcFunction handler.

code^Required

• Type: string

The actual handler code (limited to 4KiB).

---

Static Functions

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

---

isConstruct

import { Function } from '@alicloud/ros-cdk-fc'
Function.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrArn	@alicloud/ros-cdk-core.IResolvable	Attribute ARN: The ARN for ALIYUN::ROS::CustomResource.
attrFunctionId	@alicloud/ros-cdk-core.IResolvable	Attribute FunctionId: The function ID.
attrFunctionName	@alicloud/ros-cdk-core.IResolvable	Attribute FunctionName: The function name.
attrServiceId	@alicloud/ros-cdk-core.IResolvable	Attribute ServiceId: The service ID.
attrServiceName	@alicloud/ros-cdk-core.IResolvable	Attribute ServiceName: The service name.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrArn^Required

public readonly attrArn: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ARN: The ARN for ALIYUN::ROS::CustomResource.

---

attrFunctionId^Required

public readonly attrFunctionId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute FunctionId: The function ID.

---

attrFunctionName^Required

public readonly attrFunctionName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute FunctionName: The function name.

---

attrServiceId^Required

public readonly attrServiceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ServiceId: The service ID.

---

attrServiceName^Required

public readonly attrServiceName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ServiceName: The service name.

---