Skip to content

FunctionProps

Properties for defining a Function.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fc3-function

Initializer

import com.aliyun.ros.cdk.fc3.FunctionProps;
FunctionProps.builder()
    .functionName(java.lang.String)
    .functionName(IResolvable)
    .handler(java.lang.String)
    .handler(IResolvable)
    .runtime(java.lang.String)
    .runtime(IResolvable)
//  .code(IResolvable)
//  .code(CodeProperty)
//  .cpu(java.lang.Number)
//  .cpu(IResolvable)
//  .customContainerConfig(IResolvable)
//  .customContainerConfig(CustomContainerConfigProperty)
//  .customDns(IResolvable)
//  .customDns(CustomDnsProperty)
//  .customRuntimeConfig(IResolvable)
//  .customRuntimeConfig(CustomRuntimeConfigProperty)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableOndemand(java.lang.Boolean)
//  .disableOndemand(IResolvable)
//  .diskSize(java.lang.Number)
//  .diskSize(IResolvable)
//  .environmentVariables(IResolvable)
//  .environmentVariables(java.util.Map<java.lang.String, java.lang.Object>)
//  .gpuConfig(IResolvable)
//  .gpuConfig(GpuConfigProperty)
//  .instanceConcurrency(java.lang.Number)
//  .instanceConcurrency(IResolvable)
//  .instanceIsolationMode(java.lang.String)
//  .instanceIsolationMode(IResolvable)
//  .instanceLifecycleConfig(IResolvable)
//  .instanceLifecycleConfig(InstanceLifecycleConfigProperty)
//  .internetAccess(java.lang.Boolean)
//  .internetAccess(IResolvable)
//  .layers(IResolvable)
//  .layers(java.util.List<java.lang.String)
//  .layers(IResolvable>)
//  .logConfig(IResolvable)
//  .logConfig(LogConfigProperty)
//  .memorySize(java.lang.Number)
//  .memorySize(IResolvable)
//  .nasConfig(IResolvable)
//  .nasConfig(NasConfigProperty)
//  .ossMountConfig(IResolvable)
//  .ossMountConfig(OssMountConfigProperty)
//  .role(java.lang.String)
//  .role(IResolvable)
//  .sessionAffinity(java.lang.String)
//  .sessionAffinity(IResolvable)
//  .sessionAffinityConfig(IResolvable)
//  .sessionAffinityConfig(java.util.Map<java.lang.String, java.lang.Object>)
//  .tags(java.util.List<TagsProperty>)
//  .timeout(java.lang.Number)
//  .timeout(IResolvable)
//  .tracingConfig(IResolvable)
//  .tracingConfig(TracingConfigProperty)
//  .vpcConfig(IResolvable)
//  .vpcConfig(VpcConfigProperty)
    .build();

Properties

Name Type Description
functionName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property functionName: The name of the function.
handler java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property handler: The handler of the function.
runtime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property runtime: The programming language of the function.
code com.aliyun.ros.cdk.core.IResolvable OR CodeProperty Property code: Function code ZIP package.
cpu java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cpu: The CPU size of the function in vCPU as a multiple of 0.05 vCPU. The minimum value is 0.05 and the maximum value is 16. At the same time, the ratio of cpu to memorySize (in GB) should be between 1:1 and 1:4.
customContainerConfig com.aliyun.ros.cdk.core.IResolvable OR CustomContainerConfigProperty Property customContainerConfig: Custom container configuration.
customDns com.aliyun.ros.cdk.core.IResolvable OR CustomDnsProperty Property customDns: Custom DNS configuration.
customRuntimeConfig com.aliyun.ros.cdk.core.IResolvable OR CustomRuntimeConfigProperty Property customRuntimeConfig: Custom runtime configuration.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Function description.
disableOndemand java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property disableOndemand: Whether to disable the creation of on-demand instances.
diskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property diskSize: The disk size of the function, in MB.
environmentVariables com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property environmentVariables: The environment variables of the function.
gpuConfig com.aliyun.ros.cdk.core.IResolvable OR GpuConfigProperty Property gpuConfig: The GPU configuration of the function.
instanceConcurrency java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property instanceConcurrency: The maximum number of concurrent instances of the function.
instanceIsolationMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceIsolationMode: Instance isolation mode.
instanceLifecycleConfig com.aliyun.ros.cdk.core.IResolvable OR InstanceLifecycleConfigProperty Property instanceLifecycleConfig: The instance lifecycle configuration of the function.
internetAccess java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property internetAccess: Whether the function can access the Internet.
layers com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property layers: The layers of the function.
logConfig com.aliyun.ros.cdk.core.IResolvable OR LogConfigProperty Property logConfig: The log configuration of the function.
memorySize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property memorySize: The memory size of the function, in MB.
nasConfig com.aliyun.ros.cdk.core.IResolvable OR NasConfigProperty Property nasConfig: The NAS configuration of the function.
ossMountConfig com.aliyun.ros.cdk.core.IResolvable OR OssMountConfigProperty Property ossMountConfig: The OSS mount configuration of the function.
role java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property role: The user is authorized to the RAM role of Function Compute.
sessionAffinity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sessionAffinity: The session affinity policy for Function Compute requests.
sessionAffinityConfig com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property sessionAffinityConfig: Session affinity configuration.
tags java.util.List<TagsProperty> Property tags: Tags to attach to function.
timeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeout: The timeout of the function.
tracingConfig com.aliyun.ros.cdk.core.IResolvable OR TracingConfigProperty Property tracingConfig: The tracing configuration of the function.
vpcConfig com.aliyun.ros.cdk.core.IResolvable OR VpcConfigProperty Property vpcConfig: The VPC configuration of the function.

functionNameRequired

public java.lang.Object getFunctionName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property functionName: The name of the function.


handlerRequired

public java.lang.Object getHandler();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property handler: The handler of the function.


runtimeRequired

public java.lang.Object getRuntime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property runtime: The programming language of the function.


codeOptional

public java.lang.Object getCode();

Property code: Function code ZIP package.

Choose one of Code and CustomContainerConfig.


cpuOptional

public java.lang.Object getCpu();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property cpu: The CPU size of the function in vCPU as a multiple of 0.05 vCPU. The minimum value is 0.05 and the maximum value is 16. At the same time, the ratio of cpu to memorySize (in GB) should be between 1:1 and 1:4.


customContainerConfigOptional

public java.lang.Object getCustomContainerConfig();

Property customContainerConfig: Custom container configuration.

Choose one of Code and CustomContainerConfig.


customDnsOptional

public java.lang.Object getCustomDns();

Property customDns: Custom DNS configuration.


customRuntimeConfigOptional

public java.lang.Object getCustomRuntimeConfig();

Property customRuntimeConfig: Custom runtime configuration.


descriptionOptional

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Function description.


disableOndemandOptional

public java.lang.Object getDisableOndemand();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property disableOndemand: Whether to disable the creation of on-demand instances.

When enabled, on-demand instances will not be created, and only reserved instances can be used.


diskSizeOptional

public java.lang.Object getDiskSize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property diskSize: The disk size of the function, in MB.


environmentVariablesOptional

public java.lang.Object getEnvironmentVariables();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property environmentVariables: The environment variables of the function.


gpuConfigOptional

public java.lang.Object getGpuConfig();

Property gpuConfig: The GPU configuration of the function.


instanceConcurrencyOptional

public java.lang.Object getInstanceConcurrency();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property instanceConcurrency: The maximum number of concurrent instances of the function.


instanceIsolationModeOptional

public java.lang.Object getInstanceIsolationMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceIsolationMode: Instance isolation mode.


instanceLifecycleConfigOptional

public java.lang.Object getInstanceLifecycleConfig();

Property instanceLifecycleConfig: The instance lifecycle configuration of the function.


internetAccessOptional

public java.lang.Object getInternetAccess();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property internetAccess: Whether the function can access the Internet.


layersOptional

public java.lang.Object getLayers();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property layers: The layers of the function.


logConfigOptional

public java.lang.Object getLogConfig();

Property logConfig: The log configuration of the function.


memorySizeOptional

public java.lang.Object getMemorySize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property memorySize: The memory size of the function, in MB.


nasConfigOptional

public java.lang.Object getNasConfig();

Property nasConfig: The NAS configuration of the function.


ossMountConfigOptional

public java.lang.Object getOssMountConfig();

Property ossMountConfig: The OSS mount configuration of the function.


roleOptional

public java.lang.Object getRole();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property role: The user is authorized to the RAM role of Function Compute.

After setting, Function Compute will assume the role and generate temporary access credentials. The temporary access credentials of this role can be used in functions to access specified Alibaba Cloud services, such as OSS and OTS.


sessionAffinityOptional

public java.lang.Object getSessionAffinity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sessionAffinity: The session affinity policy for Function Compute requests.

Set to MCP_SSE to implement MCP SSE protocol request affinity. Set to GENERATED_COOKIE for cookie-based affinity. Set to HEADER_FIELD for header-based affinity. If not set or set to NONE, there is no affinity effect, and requests are routed according to the default scheduling policy of Function Compute.


sessionAffinityConfigOptional

public java.lang.Object getSessionAffinityConfig();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property sessionAffinityConfig: Session affinity configuration.


tagsOptional

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to function.

Max support 20 tags to add during create function. Each tag with two properties Key and Value, and Key is required.


timeoutOptional

public java.lang.Object getTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeout: The timeout of the function.


tracingConfigOptional

public java.lang.Object getTracingConfig();

Property tracingConfig: The tracing configuration of the function.


vpcConfigOptional

public java.lang.Object getVpcConfig();

Property vpcConfig: The VPC configuration of the function.