GroupProps

Properties for defining a Group.

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

Initializer

import ros_cdk_apigateway
ros_cdk_apigateway.GroupProps(
  group_name: typing.Union[str, IResolvable],
  base_path: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  internet_enable: typing.Union[bool, IResolvable] = None,
  passthrough_headers: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_intranet_enable: typing.Union[bool, IResolvable] = None
)

Properties

Name	Type	Description
group_name	typing.Union[str, ros_cdk_core.IResolvable]	Property groupName: The name of the Group.Need [4, 50] Chinese\English\Number characters or "_",and should start with Chinese\/English character.
base_path	typing.Union[str, ros_cdk_core.IResolvable]	Property basePath: The base path of API.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: Description of the Group, less than 180 characters.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceId: API gateway instance ID.
internet_enable	typing.Union[bool, ros_cdk_core.IResolvable]	Property internetEnable: Enable or disable internet subdomain.
passthrough_headers	typing.Union[str, ros_cdk_core.IResolvable]	Property passthroughHeaders: Pass through headers setting.
tags	typing.List[TagsProperty]	Property tags: Tags to attach to group.
vpc_intranet_enable	typing.Union[bool, ros_cdk_core.IResolvable]	Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

---

group_name^Required

group_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property groupName: The name of the Group.Need [4, 50] Chinese\English\Number characters or "_",and should start with Chinese\/English character.

---

base_path^Optional

base_path: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property basePath: The base path of API.

---

description^Optional

description: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

---

instance_id^Optional

instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

---

internet_enable^Optional

internet_enable: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property internetEnable: Enable or disable internet subdomain.

True for enable.

---

passthrough_headers^Optional

passthrough_headers: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property passthroughHeaders: Pass through headers setting.

values: host: pass through host headers

---

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[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.

---

vpc_intranet_enable^Optional

vpc_intranet_enable: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

True for enable.

---