Skip to content

Group

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

Initializers 

import ros_cdk_apigateway
ros_cdk_apigateway.Group(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

group_nameRequired

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

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

Property basePath: The base path of API.

descriptionOptional

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

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

instance_idOptional

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

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

Property internetEnable: Enable or disable internet subdomain.

True for enable.

passthrough_headersOptional

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

Property passthroughHeaders: Pass through headers setting.

values: host: pass through host headers

tagsOptional

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_enableOptional

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

Property vpcIntranetEnable: Enable or disable VPC intranet subdomain.

True for enable.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

import ros_cdk_apigateway
ros_cdk_apigateway.Group.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_group_id ros_cdk_core.IResolvable Attribute GroupId: The id of the created Group resource.
attr_sub_domain ros_cdk_core.IResolvable Attribute SubDomain: The sub domain assigned to the Group by the system.
attr_tags ros_cdk_core.IResolvable Attribute Tags: Tags of app.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_group_idRequired 

attr_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GroupId: The id of the created Group resource.

attr_sub_domainRequired 

attr_sub_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: Tags of app.