GroupProps

Properties for defining a Group.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-group

Initializer

import { GroupProps } from '@alicloud/ros-cdk-apigateway'
const groupProps: GroupProps = { ... }

Properties

groupName^Required

public readonly groupName: string | IResolvable;

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

Property groupName: The name of the API group.

The name must be unique and 4 to 50 characters in length. It must start with a letter or a Chinese character and can contain letters, digits, underscores (_), and Chinese characters. If you do not specify this parameter, the name is not modified.

basePath^Optional

public readonly basePath: string | IResolvable;

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

Property basePath: The base path of API.

description^Optional

public readonly description: string | IResolvable;

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

Property description: Description of the Group, less than 180 characters.

instanceId^Optional

public readonly instanceId: string | IResolvable;

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

Property instanceId: API gateway instance ID.

For example, "api-shared-vpc-001" means vpc instance, while "api-shared-classic-001" means classic instance.

internetEnable^Optional

public readonly internetEnable: boolean | IResolvable;

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

Property internetEnable: Enable or disable internet subdomain.

True for enable.

passthroughHeaders^Optional

public readonly passthroughHeaders: string | IResolvable;

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

Property passthroughHeaders: Pass through headers setting.

values: host: pass through host headers

tags^Optional

public readonly tags: TagsProperty[];

• Type: TagsProperty[]

Property tags: Tags to attach to group.

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

vpcIntranetEnable^Optional

public readonly vpcIntranetEnable: boolean | IResolvable;

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

Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

True for enable.