GatewayProps

Properties for defining a Gateway.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-gateway

Initializer

import ros_cdk_apig
ros_cdk_apig.GatewayProps(
  gateway_name: typing.Union[str, IResolvable],
  network_access_config: typing.Union[IResolvable, NetworkAccessConfigProperty],
  payment_type: typing.Union[str, IResolvable],
  spec: typing.Union[str, IResolvable],
  zone_config: typing.Union[IResolvable, ZoneConfigProperty],
  gateway_type: typing.Union[str, IResolvable] = None,
  log_config: typing.Union[IResolvable, LogConfigProperty] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc: typing.Union[IResolvable, VpcProperty] = None,
  v_switch: typing.Union[IResolvable, VSwitchProperty] = None
)

Properties

gateway_name^Required

gateway_name: typing.Union[str, IResolvable]

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

Property gatewayName: The name of the Gateway.

network_access_config^Required

network_access_config: typing.Union[IResolvable, NetworkAccessConfigProperty]

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

Property networkAccessConfig: Network Access Configuration.

payment_type^Required

payment_type: typing.Union[str, IResolvable]

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

Property paymentType: The payment type of the gateway.

Valid values:

• PayAsYouGo
• Subscription

spec^Required

spec: typing.Union[str, IResolvable]

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

Property spec: Gateway instance specifications.

zone_config^Required

zone_config: typing.Union[IResolvable, ZoneConfigProperty]

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

Property zoneConfig: Availability Zone Configuration.

gateway_type^Optional

gateway_type: typing.Union[str, IResolvable]

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

Property gatewayType: Describes the gateway type, which is categorized into the following two types: * API: indicates an API gateway * AI: Indicates an AI gateway.

Default value: API.

log_config^Optional

log_config: typing.Union[IResolvable, LogConfigProperty]

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

Property logConfig: Log Configuration.

period^Optional

period: typing.Union[typing.Union[int, float], IResolvable]

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

Property period: The purchase time of the gateway.

This parameter is only valid when updating PaymentType from PayAsYouGo to Subscription.

period_unit^Optional

period_unit: typing.Union[str, IResolvable]

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

Property periodUnit: The unit of the purchase time of the gateway.

This parameter is only valid when updating PaymentType from PayAsYouGo to Subscription.

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

Property resourceGroupId: The ID of the resource group.

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

Property tags: Tags of The tags of the Gateway..

vpc^Optional

vpc: typing.Union[IResolvable, VpcProperty]

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

Property vpc: The VPC associated with the Gateway.

v_switch^Optional

v_switch: typing.Union[IResolvable, VSwitchProperty]

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

Property vSwitch: The virtual switch associated with the Gateway.