Skip to content

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

using AlibabaCloud.SDK.ROS.CDK.Fc;
new Function(Construct Scope, string Id, FunctionProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props FunctionProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • Type: bool

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

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

CodeFromAsset

private void CodeFromAsset(string Path)

Loads the fcFunction code from a local disk path.

PathRequired

  • Type: string

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


CodeFromBucket

private void CodeFromBucket(Bucket Bucket, string Key)

Function handler code as an OSS object.

BucketRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Oss.Bucket

The OSS bucket.


KeyRequired

  • Type: string

The object key.


CodeFromInline

private void CodeFromInline(string Code)

Inline code for FC fcFunction handler.

CodeRequired

  • Type: string

The actual handler code (limited to 4KiB).


Static Functions

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

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Fc;
Function.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrArn AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ARN: The ARN for ALIYUN::ROS::CustomResource.
AttrFunctionId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute FunctionId: The function ID.
AttrFunctionName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute FunctionName: The function name.
AttrServiceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ServiceId: The service ID.
AttrServiceName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ServiceName: The service name.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrArnRequired

public IResolvable AttrArn { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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


AttrFunctionIdRequired

public IResolvable AttrFunctionId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute FunctionId: The function ID.


AttrFunctionNameRequired

public IResolvable AttrFunctionName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute FunctionName: The function name.


AttrServiceIdRequired

public IResolvable AttrServiceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ServiceId: The service ID.


AttrServiceNameRequired

public IResolvable AttrServiceName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ServiceName: The service name.