Gateway2

• Implements: IGateway2

This class encapsulates and extends the ROS resource type ALIYUN::MSE::Gateway2.

Initializers

import ros_cdk_mse
ros_cdk_mse.Gateway2(
  scope: Construct,
  id: str,
  vpc_id: typing.Union[str, IResolvable],
  accept_language: typing.Union[str, IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  clb_network_type: typing.Union[str, IResolvable] = None,
  enable_hardware_acceleration: typing.Union[bool, IResolvable] = None,
  enable_sls: typing.Union[bool, IResolvable] = None,
  enable_xtrace: typing.Union[bool, IResolvable] = None,
  enterprise_security_group: typing.Union[bool, IResolvable] = None,
  internet_slb: typing.Union[str, IResolvable] = None,
  managed_entry_network_type: typing.Union[str, IResolvable] = None,
  mser_version: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  nlb_network_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  replica: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  slb_spec: typing.Union[str, IResolvable] = None,
  spec: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  v_switch_id2: typing.Union[str, IResolvable] = None,
  xtrace_ratio: typing.Union[typing.Union[int, float], IResolvable] = None,
  zone_info: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneInfoProperty]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

vpc_id^Required

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

Property vpcId: The ID of the vpc.

accept_language^Optional

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

Property acceptLanguage: The language of the response.

Valid values: zh: Chinese en: English

charge_type^Optional

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

Property chargeType: The billing method you specify when you purchase an normal instance.

Valid values: PREPAY: subscription POSTPAY: pay-as-you-go

clb_network_type^Optional

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

Property clbNetworkType: The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs.

pubnet: Internet privatenet: private network privatepubnet: Internet and private network

enable_hardware_acceleration^Optional

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

Property enableHardwareAcceleration: Specifies whether to enable hardware acceleration.

enable_sls^Optional

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

Property enableSls: Specifies whether to activate Log Service.

enable_xtrace^Optional

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

Property enableXtrace: Whether to activate Tracing Analysis.

enterprise_security_group^Optional

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

Property enterpriseSecurityGroup: Specifies whether to use an Enterprise Security Group.

internet_slb^Optional

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

Property internetSlb: Public network SLB specifications (for normal instances).

Simple type (slb.s1.small) Standard type 1 (slb.s2.smal) Standard type I(slb.s2.medium) Advanced Type 1 (slb.s3.small) Advanced I(slb.s3.medium) Super strong type I (slb.s3.large) Description Traditional example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU, and CLB specifications. Serverless example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU

managed_entry_network_type^Optional

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

Property managedEntryNetworkType: Gateway entrance type (applicable to the mse_premium instance) pubnet: public network privatenet: privatenet privatepubnet: public + private network.

mser_version^Optional

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

Property mserVersion: The edition of the gateway.

• mse_premium: Professional Edition
• mse_pro: Standard Edition
• mse_serverless: Serverless Edition

name^Optional

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

Property name: The name of the created gateway.

nlb_network_type^Optional

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

Property nlbNetworkType: The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance.

pubnet: Internet privatenet: private network privatepubnet: Internet and private network

period^Optional

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

Property period: Prepaid time period.

While choose by pay by month, it could be from 1 to 9. While choose pay by year, it could be from 1 to 3. This parameter is Only valid when updating from postpaid instance to prepaid instance.

period_unit^Optional

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

Property periodUnit: Charge period for created instances.

This parameter is only valid when updating from postpaid instance to prepaid instance.

replica^Optional

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

Property replica: The number of nodes you specify when you purchase an normal instance.

For high availability, the value for this param is recommended to be greater than 2.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

slb_spec^Optional

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

Property slbSpec: Private network SLB specifications (for normal instances).

Simple type (slb.s1.small) Standard type 1 (slb.s2.small) Standard type I(slb.s2.medium) Advanced Type 1 (slb.s3.small) Advanced I(slb.s3.medium) Super strong type I (slb.s3.large) Description Traditional example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU, and CLB specifications. Serverless example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU

spec^Optional

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

Property spec: The node specifications you specify when you purchase an normal instance.

Valid values: MSE_GTW_16_32_200_c(16C32G) MSE_GTW_2_4_200_c(2C4G) MSE_GTW_4_8_200_c(4C8G) MSE_GTW_8_16_200_c(8C16G)

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: The list of tags in the form of key\/value pairs.

You can define a maximum of 20 tags.

v_switch_id^Optional

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

Property vSwitchId: The primary VSwitch ID.

v_switch_id2^Optional

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

Property vSwitchId2: The secondary VSwitch ID.

xtrace_ratio^Optional

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

Property xtraceRatio: The sampling rate of Tracing Analysis.

Valid values: [1,100]

zone_info^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneInfoProperty]]]

Property zoneInfo: The info details of the available zone.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_mse
ros_cdk_mse.Gateway2.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_gateway_unique_id^Required

attr_gateway_unique_id: typing.Union[str, IResolvable]

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

Attribute GatewayUniqueId: The unique ID of the gateway.

props^Required

props: Gateway2Props

• Type: Gateway2Props