Gateway

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Gateway.

Initializers

import ros_cdk_apig
ros_cdk_apig.Gateway(
  scope: Construct,
  id: str,
  payment_type: typing.Union[str, IResolvable],
  spec: typing.Union[str, IResolvable],
  zone_config: typing.Union[IResolvable, ZoneConfigProperty],
  gateway_name: typing.Union[str, IResolvable] = None,
  log_config: typing.Union[IResolvable, LogConfigProperty] = None,
  network_access_config: typing.Union[IResolvable, NetworkAccessConfigProperty] = None,
  vpc: typing.Union[IResolvable, VpcProperty] = None,
  v_switch: typing.Union[IResolvable, VSwitchProperty] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
payment_type	typing.Union[str, ros_cdk_core.IResolvable]	Property paymentType: The payment type of the gateway.
spec	typing.Union[str, ros_cdk_core.IResolvable]	Property spec: Gateway instance specifications.
zone_config	typing.Union[ros_cdk_core.IResolvable, ZoneConfigProperty]	Property zoneConfig: Availability Zone Configuration.
gateway_name	typing.Union[str, ros_cdk_core.IResolvable]	Property gatewayName: The name of the Gateway.
log_config	typing.Union[ros_cdk_core.IResolvable, LogConfigProperty]	Property logConfig: Log Configuration.
network_access_config	typing.Union[ros_cdk_core.IResolvable, NetworkAccessConfigProperty]	Property networkAccessConfig: Network Access Configuration.
vpc	typing.Union[ros_cdk_core.IResolvable, VpcProperty]	Property vpc: The VPC associated with the Gateway.
v_switch	typing.Union[ros_cdk_core.IResolvable, VSwitchProperty]	Property vSwitch: The virtual switch associated with the Gateway.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

payment_type^Required

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

Property paymentType: The payment type of the gateway.

Valid values:

• PayAsYouGo
• Subscription

---

spec^Required

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

Property spec: Gateway instance specifications.

---

zone_config^Required

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

Property zoneConfig: Availability Zone Configuration.

---

gateway_name^Optional

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

Property gatewayName: The name of the Gateway.

---

log_config^Optional

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

Property logConfig: Log Configuration.

---

network_access_config^Optional

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

Property networkAccessConfig: Network Access Configuration.

---

vpc^Optional

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

Property vpc: The VPC associated with the Gateway.

---

v_switch^Optional

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

Property vSwitch: The virtual switch associated with the Gateway.

---

enable_resource_property_constraint^Optional

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

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

---

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

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

---

is_construct

import ros_cdk_apig
ros_cdk_apig.Gateway.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The creation timestamp.
attr_environments	ros_cdk_core.IResolvable	Attribute Environments: The list of environments associated with the Gateway.
attr_expire_time	ros_cdk_core.IResolvable	Attribute ExpireTime: Package year and package month expiration timestamp.
attr_gateway_id	ros_cdk_core.IResolvable	Attribute GatewayId: The ID of the Gateway.
attr_gateway_name	ros_cdk_core.IResolvable	Attribute GatewayName: The name of the resource.
attr_load_balancers	ros_cdk_core.IResolvable	Attribute LoadBalancers: The list of Gateway ingress addresses.
attr_payment_type	ros_cdk_core.IResolvable	Attribute PaymentType: The payment type of the gateway.
attr_security_group	ros_cdk_core.IResolvable	Attribute SecurityGroup: The Security Group of the Gateway.
attr_spec	ros_cdk_core.IResolvable	Attribute Spec: Gateway instance specifications.
attr_update_time	ros_cdk_core.IResolvable	Attribute UpdateTime: Update the timestamp.
attr_version	ros_cdk_core.IResolvable	Attribute Version: The gateway version.
attr_vpc	ros_cdk_core.IResolvable	Attribute Vpc: The VPC associated with the Gateway.
attr_v_switch	ros_cdk_core.IResolvable	Attribute VSwitch: The virtual switch associated with the Gateway.
attr_zones	ros_cdk_core.IResolvable	Attribute Zones: The List of zones associated with the Gateway.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation timestamp.

Unit: milliseconds.

---

attr_environments^Required

attr_environments: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Environments: The list of environments associated with the Gateway.

---

attr_expire_time^Required

attr_expire_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ExpireTime: Package year and package month expiration timestamp.

Unit: milliseconds.

---

attr_gateway_id^Required

attr_gateway_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GatewayId: The ID of the Gateway.

---

attr_gateway_name^Required

attr_gateway_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GatewayName: The name of the resource.

---

attr_load_balancers^Required

attr_load_balancers: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LoadBalancers: The list of Gateway ingress addresses.

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PaymentType: The payment type of the gateway.

---

attr_security_group^Required

attr_security_group: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecurityGroup: The Security Group of the Gateway.

---

attr_spec^Required

attr_spec: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Spec: Gateway instance specifications.

---

attr_update_time^Required

attr_update_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UpdateTime: Update the timestamp.

Unit: milliseconds.

---

attr_version^Required

attr_version: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Version: The gateway version.

---

attr_vpc^Required

attr_vpc: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Vpc: The VPC associated with the Gateway.

---

attr_v_switch^Required

attr_v_switch: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VSwitch: The virtual switch associated with the Gateway.

---

attr_zones^Required

attr_zones: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Zones: The List of zones associated with the Gateway.

---