Skip to content

ServiceProps

Properties for defining a Service.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fc-service

Initializer 

import com.aliyun.ros.cdk.fc.ServiceProps;
ServiceProps.builder()
    .serviceName(java.lang.String)
    .serviceName(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .internetAccess(java.lang.Boolean)
//  .internetAccess(IResolvable)
//  .logConfig(IResolvable)
//  .logConfig(LogConfigProperty)
//  .nasConfig(IResolvable)
//  .nasConfig(NasConfigProperty)
//  .ossMountConfig(IResolvable)
//  .ossMountConfig(OssMountConfigProperty)
//  .role(java.lang.String)
//  .role(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tracingConfig(IResolvable)
//  .tracingConfig(TracingConfigProperty)
//  .vpcBindings(IResolvable)
//  .vpcBindings(java.util.List<java.lang.String)
//  .vpcBindings(IResolvable>)
//  .vpcConfig(IResolvable)
//  .vpcConfig(VpcConfigProperty)
    .build();

Properties

Name Type Description
serviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceName: Service name.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Service description.
internetAccess java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property internetAccess: Set it to true to enable Internet access.
logConfig com.aliyun.ros.cdk.core.IResolvable OR LogConfigProperty Property logConfig: Log configuration.
nasConfig com.aliyun.ros.cdk.core.IResolvable OR NasConfigProperty Property nasConfig: NAS configuration.
ossMountConfig com.aliyun.ros.cdk.core.IResolvable OR OssMountConfigProperty Property ossMountConfig: The OSS mount configurations.
role java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.
tags java.util.List<TagsProperty> Property tags: Tags to attach to service.
tracingConfig com.aliyun.ros.cdk.core.IResolvable OR TracingConfigProperty Property tracingConfig: The Tracing Analysis configuration.
vpcBindings com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property vpcBindings: Function Invocation only by Specified VPCs.
vpcConfig com.aliyun.ros.cdk.core.IResolvable OR VpcConfigProperty Property vpcConfig: VPC configuration.

serviceNameRequired 

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

Property serviceName: Service name.

deletionForceOptional 

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

Property deletionForce: Whether force delete the service without waiting for network interfaces to be cleaned up if VpcConfig is specified.

Default value is false.

descriptionOptional 

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

Property description: Service description.

internetAccessOptional 

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

Property internetAccess: Set it to true to enable Internet access.

logConfigOptional 

public java.lang.Object getLogConfig();

Property logConfig: Log configuration.

Function Compute pushes function execution logs to the configured log store.

nasConfigOptional 

public java.lang.Object getNasConfig();

Property nasConfig: NAS configuration.

Function Compute uses a specified NAS configured on the service.

ossMountConfigOptional 

public java.lang.Object getOssMountConfig();

Property ossMountConfig: The OSS mount configurations.

roleOptional 

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

Property role: The role grants Function Compute the permission to access user’s cloud resources, such as pushing logs to user’s log store.

The temporary STS token generated from this role can be retrieved from function context and used to access cloud resources.

tagsOptional 

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

Property tags: Tags to attach to service.

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

tracingConfigOptional 

public java.lang.Object getTracingConfig();

Property tracingConfig: The Tracing Analysis configuration.

After Function Compute integrates with Tracing Analysis, you can record the stay time of a request in Function Compute, view the cold start time for a function, and record the execution time of a function.

vpcBindingsOptional 

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

Property vpcBindings: Function Invocation only by Specified VPCs.

By default, you can invoke the function by using the Internet endpoint and internal endpoint after a function is created. If you want the function to be invoked only by using specified VPCs, but not the Internet endpoint or internal endpoint, you must bind the specified VPCs to the service.

vpcConfigOptional 

public java.lang.Object getVpcConfig();

Property vpcConfig: VPC configuration.

Function Compute uses the config to setup ENI in the specific VPC.