Skip to content

GatewayProps

Properties for defining a Gateway.

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

Initializer

import com.aliyun.ros.cdk.apig.GatewayProps;
GatewayProps.builder()
    .gatewayName(java.lang.String)
    .gatewayName(IResolvable)
    .networkAccessConfig(IResolvable)
    .networkAccessConfig(NetworkAccessConfigProperty)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
    .spec(java.lang.String)
    .spec(IResolvable)
    .zoneConfig(IResolvable)
    .zoneConfig(ZoneConfigProperty)
//  .gatewayType(java.lang.String)
//  .gatewayType(IResolvable)
//  .logConfig(IResolvable)
//  .logConfig(LogConfigProperty)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpc(IResolvable)
//  .vpc(VpcProperty)
//  .vSwitch(IResolvable)
//  .vSwitch(VSwitchProperty)
    .build();

Properties

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

gatewayNameRequired

public java.lang.Object getGatewayName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property gatewayName: The name of the Gateway.


networkAccessConfigRequired

public java.lang.Object getNetworkAccessConfig();

Property networkAccessConfig: Network Access Configuration.


paymentTypeRequired

public java.lang.Object getPaymentType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The payment type of the gateway.

Valid values:

  • PayAsYouGo
  • Subscription

specRequired

public java.lang.Object getSpec();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property spec: Gateway instance specifications.


zoneConfigRequired

public java.lang.Object getZoneConfig();

Property zoneConfig: Availability Zone Configuration.


gatewayTypeOptional

public java.lang.Object getGatewayType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getLogConfig();

Property logConfig: Log Configuration.


periodOptional

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriodUnit();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.


tagsOptional

public java.util.List<TagsProperty> getTags();

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


vpcOptional

public java.lang.Object getVpc();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR VpcProperty

Property vpc: The VPC associated with the Gateway.


vSwitchOptional

public java.lang.Object getVSwitch();

Property vSwitch: The virtual switch associated with the Gateway.