Skip to content

GatewayProps

Properties for defining a Gateway.

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

Initializer 

import { GatewayProps } from '@alicloud/ros-cdk-apig'
const gatewayProps: GatewayProps = { ... }

Properties

Name Type Description
gatewayName string | @alicloud/ros-cdk-core.IResolvable Property gatewayName: The name of the Gateway.
networkAccessConfig @alicloud/ros-cdk-core.IResolvable | NetworkAccessConfigProperty Property networkAccessConfig: Network Access Configuration.
paymentType string | @alicloud/ros-cdk-core.IResolvable Property paymentType: The payment type of the gateway.
spec string | @alicloud/ros-cdk-core.IResolvable Property spec: Gateway instance specifications.
zoneConfig @alicloud/ros-cdk-core.IResolvable | ZoneConfigProperty Property zoneConfig: Availability Zone Configuration.
gatewayType string | @alicloud/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.
logConfig @alicloud/ros-cdk-core.IResolvable | LogConfigProperty Property logConfig: Log Configuration.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The purchase time of the gateway.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the purchase time of the gateway.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags of The tags of the Gateway..
vpc @alicloud/ros-cdk-core.IResolvable | VpcProperty Property vpc: The VPC associated with the Gateway.
vSwitch @alicloud/ros-cdk-core.IResolvable | VSwitchProperty Property vSwitch: The virtual switch associated with the Gateway.

gatewayNameRequired 

public readonly gatewayName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property gatewayName: The name of the Gateway.

networkAccessConfigRequired 

public readonly networkAccessConfig: IResolvable | NetworkAccessConfigProperty;

Property networkAccessConfig: Network Access Configuration.

paymentTypeRequired 

public readonly paymentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property paymentType: The payment type of the gateway.

Valid values: * PayAsYouGo * Subscription

specRequired 

public readonly spec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property spec: Gateway instance specifications.

zoneConfigRequired 

public readonly zoneConfig: IResolvable | ZoneConfigProperty;

Property zoneConfig: Availability Zone Configuration.

gatewayTypeOptional 

public readonly gatewayType: string | IResolvable;
  • Type: string | @alicloud/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.

logConfigOptional 

public readonly logConfig: IResolvable | LogConfigProperty;

Property logConfig: Log Configuration.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The purchase time of the gateway.

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

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly tags: TagsProperty[];

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

vpcOptional 

public readonly vpc: IResolvable | VpcProperty;
  • Type: @alicloud/ros-cdk-core.IResolvable | VpcProperty

Property vpc: The VPC associated with the Gateway.

vSwitchOptional 

public readonly vSwitch: IResolvable | VSwitchProperty;

Property vSwitch: The virtual switch associated with the Gateway.