Gateway

• Implements: IGateway

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Gateway, which is used to create a Cloud-native API Gateway.

Initializers

import ros_cdk_apig
ros_cdk_apig.Gateway(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

gateway_name^Required

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

Property gatewayName: The name of the Gateway.

network_access_config^Required

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

Property networkAccessConfig: Network Access Configuration.

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_type^Optional

• 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

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

Property logConfig: Log Configuration.

period^Optional

• 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

• 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

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

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: typing.List[TagsProperty]

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

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

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_apig
ros_cdk_apig.Gateway.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_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation timestamp.

Unit: milliseconds.

attr_environments^Required

attr_environments: typing.Union[str, IResolvable]

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

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

attr_expire_time^Required

attr_expire_time: typing.Union[str, IResolvable]

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

Attribute ExpireTime: Package year and package month expiration timestamp.

Unit: milliseconds.

attr_gateway_id^Required

attr_gateway_id: typing.Union[str, IResolvable]

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

Attribute GatewayId: The ID of the Gateway.

attr_gateway_name^Required

attr_gateway_name: typing.Union[str, IResolvable]

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

Attribute GatewayName: The name of the resource.

attr_gateway_type^Required

attr_gateway_type: typing.Union[str, IResolvable]

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

Attribute GatewayType: The type of the gateway.

attr_load_balancers^Required

attr_load_balancers: typing.Union[str, IResolvable]

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

Attribute LoadBalancers: The list of Gateway ingress addresses.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: The payment type of the gateway.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_security_group^Required

attr_security_group: typing.Union[str, IResolvable]

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

Attribute SecurityGroup: The Security Group of the Gateway.

attr_spec^Required

attr_spec: typing.Union[str, IResolvable]

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

Attribute Spec: Gateway instance specifications.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: The tags of the Gateway.

attr_update_time^Required

attr_update_time: typing.Union[str, IResolvable]

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

Attribute UpdateTime: Update the timestamp.

Unit: milliseconds.

attr_version^Required

attr_version: typing.Union[str, IResolvable]

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

Attribute Version: The gateway version.

attr_vpc^Required

attr_vpc: typing.Union[str, IResolvable]

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

Attribute Vpc: The VPC associated with the Gateway.

attr_v_switch^Required

attr_v_switch: typing.Union[str, IResolvable]

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

Attribute VSwitch: The virtual switch associated with the Gateway.

attr_zones^Required

attr_zones: typing.Union[str, IResolvable]

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

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

props^Required

props: GatewayProps

• Type: GatewayProps