Group

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Group, which is used to create an API group.

Initializers

import com.aliyun.ros.cdk.apigateway.Group;
Group.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
groupName	java.lang.String OR com.aliyun.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	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.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

groupName^Required

• Type: java.lang.String OR com.aliyun.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^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property basePath: The base path of API.

---

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

instanceId^Optional

• 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.

---

internetEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property internetEnable: Enable or disable internet subdomain.

True for enable.

---

passthroughHeaders^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property passthroughHeaders: Pass through headers setting.

values: host: pass through host headers

---

tags^Optional

• Type: java.util.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.

---

vpcIntranetEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

True for enable.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.apigateway.Group;
Group.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute GroupId: The id of the created Group resource.
attrSubDomain	com.aliyun.ros.cdk.core.IResolvable	Attribute SubDomain: The sub domain assigned to the Group by the system.
attrTags	com.aliyun.ros.cdk.core.IResolvable	Attribute Tags: Tags of app.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrGroupId^Required

public IResolvable getAttrGroupId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GroupId: The id of the created Group resource.

---

attrSubDomain^Required

public IResolvable getAttrSubDomain();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SubDomain: The sub domain assigned to the Group by the system.

---

attrTags^Required

public IResolvable getAttrTags();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: Tags of app.

---