Skip to content

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

Name Type Description
groupName string | @alicloud/ros-cdk-core.IResolvable Property groupName: The name of the Group.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.
basePath string | @alicloud/ros-cdk-core.IResolvable Property basePath: The base path of API.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the Group, less than 180 characters.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: API gateway instance ID.
internetEnable boolean | @alicloud/ros-cdk-core.IResolvable Property internetEnable: Enable or disable internet subdomain.
passthroughHeaders string | @alicloud/ros-cdk-core.IResolvable Property passthroughHeaders: Pass through headers setting.
tags TagsProperty[] Property tags: Tags to attach to group.
vpcIntranetEnable boolean | @alicloud/ros-cdk-core.IResolvable Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

groupNameRequired 

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

Property groupName: The name of the Group.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.

basePathOptional 

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

Property basePath: The base path of API.

descriptionOptional 

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

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

instanceIdOptional 

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.

internetEnableOptional 

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

Property internetEnable: Enable or disable internet subdomain.

True for enable.

passthroughHeadersOptional 

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

Property passthroughHeaders: Pass through headers setting.

values: host: pass through host headers

tagsOptional 

public readonly tags: 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.

vpcIntranetEnableOptional 

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

Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

True for enable.