Skip to content

GroupProps

Properties for defining a Group.

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

Initializer 

import com.aliyun.ros.cdk.apigateway.GroupProps;
GroupProps.builder()
    .groupName(java.lang.String)
    .groupName(IResolvable)
//  .basePath(java.lang.String)
//  .basePath(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .internetEnable(java.lang.Boolean)
//  .internetEnable(IResolvable)
//  .passthroughHeaders(java.lang.String)
//  .passthroughHeaders(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcIntranetEnable(java.lang.Boolean)
//  .vpcIntranetEnable(IResolvable)
    .build();

Properties

Name Type Description
groupName java.lang.String OR com.aliyun.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.
basePath java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property basePath: The base path of API.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the Group, less than 180 characters.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: API gateway instance ID.
internetEnable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property internetEnable: Enable or disable internet subdomain.
passthroughHeaders java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property passthroughHeaders: Pass through headers setting.
tags java.util.List<TagsProperty> Property tags: Tags to attach to group.
vpcIntranetEnable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

groupNameRequired 

public java.lang.Object getGroupName();
  • Type: java.lang.String OR com.aliyun.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.

basePathOptional 

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

Property basePath: The base path of API.

descriptionOptional 

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

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

instanceIdOptional 

public java.lang.Object getInstanceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInternetEnable();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property internetEnable: Enable or disable internet subdomain.

True for enable.

passthroughHeadersOptional 

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

Property passthroughHeaders: Pass through headers setting.

values: host: pass through host headers

tagsOptional 

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

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 java.lang.Object getVpcIntranetEnable();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

True for enable.