Group

• Implements: IGroup

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::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();

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

• 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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrGroupId();

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

Attribute GroupId: The id of the created Group resource.

attrSubDomain^Required

public java.lang.Object getAttrSubDomain();

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

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

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: Tags of app.

props^Required

public GroupProps getProps();

• Type: GroupProps