Function

• Implements: IFunction

This class encapsulates and extends the ROS resource type ALIYUN::FC::Function.

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Required

• Type: FunctionProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

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

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 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: string | IResolvable;

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

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

attrFunctionId^Required

public readonly attrFunctionId: string | IResolvable;

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

Attribute FunctionId: The function ID.

attrFunctionName^Required

public readonly attrFunctionName: string | IResolvable;

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

Attribute FunctionName: The function name.

attrServiceId^Required

public readonly attrServiceId: string | IResolvable;

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

Attribute ServiceId: The service ID.

attrServiceName^Required

public readonly attrServiceName: string | IResolvable;

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

Attribute ServiceName: The service name.

props^Required

public readonly props: FunctionProps;

• Type: FunctionProps