Skip to content

ServiceProps

Properties for defining a Service.

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

Initializer 

import { ServiceProps } from '@alicloud/ros-cdk-fc'
const serviceProps: ServiceProps = { ... }

Properties

Name Type Description
serviceName string | @alicloud/ros-cdk-core.IResolvable Property serviceName: Service name.
deletionForce boolean | @alicloud/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 string | @alicloud/ros-cdk-core.IResolvable Property description: Service description.
internetAccess boolean | @alicloud/ros-cdk-core.IResolvable Property internetAccess: Set it to true to enable Internet access.
logConfig @alicloud/ros-cdk-core.IResolvable | LogConfigProperty Property logConfig: Log configuration.
nasConfig @alicloud/ros-cdk-core.IResolvable | NasConfigProperty Property nasConfig: NAS configuration.
ossMountConfig @alicloud/ros-cdk-core.IResolvable | OssMountConfigProperty Property ossMountConfig: The OSS mount configurations.
role string | @alicloud/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 TagsProperty[] Property tags: Tags to attach to service.
tracingConfig @alicloud/ros-cdk-core.IResolvable | TracingConfigProperty Property tracingConfig: The Tracing Analysis configuration.
vpcBindings @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property vpcBindings: Function Invocation only by Specified VPCs.
vpcConfig @alicloud/ros-cdk-core.IResolvable | VpcConfigProperty Property vpcConfig: VPC configuration.

serviceNameRequired 

public readonly serviceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property serviceName: Service name.

deletionForceOptional 

public readonly deletionForce: boolean | IResolvable;
  • Type: boolean | @alicloud/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 readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Service description.

internetAccessOptional 

public readonly internetAccess: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

logConfigOptional 

public readonly logConfig: IResolvable | LogConfigProperty;

Property logConfig: Log configuration.

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

nasConfigOptional 

public readonly nasConfig: IResolvable | NasConfigProperty;

Property nasConfig: NAS configuration.

Function Compute uses a specified NAS configured on the service.

ossMountConfigOptional 

public readonly ossMountConfig: IResolvable | OssMountConfigProperty;

Property ossMountConfig: The OSS mount configurations.

roleOptional 

public readonly role: string | IResolvable;
  • Type: string | @alicloud/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 readonly tags: TagsProperty[];

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 readonly tracingConfig: IResolvable | TracingConfigProperty;

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 readonly vpcBindings: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

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 readonly vpcConfig: IResolvable | VpcConfigProperty;

Property vpcConfig: VPC configuration.

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