HttpApi

• Implements: IHttpApi

This class encapsulates and extends the ROS resource type ALIYUN::APIG::HttpApi, which is used to create an HTTP API.

Initializers

import ros_cdk_apig
ros_cdk_apig.HttpApi(
  scope: Construct,
  id: str,
  http_api_name: typing.Union[str, IResolvable],
  agent_protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  ai_protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  auth_config: typing.Union[IResolvable, AuthConfigProperty] = None,
  base_path: typing.Union[str, IResolvable] = None,
  belong_gateway_id: typing.Union[str, IResolvable] = None,
  builtin_route_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  deploy_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DeployConfigsProperty]]] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_auth: typing.Union[bool, IResolvable] = None,
  first_byte_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  ingress_config: typing.Union[IResolvable, IngressConfigProperty] = None,
  model_category: typing.Union[str, IResolvable] = None,
  only_change_config: typing.Union[bool, IResolvable] = None,
  protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  remove_base_path_on_forward: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  strategy: typing.Union[str, IResolvable] = None,
  type: typing.Union[str, IResolvable] = None,
  version_config: typing.Union[IResolvable, VersionConfigProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

http_api_name^Required

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

Property httpApiName: The name of the HTTP API.

agent_protocols^Optional

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

Property agentProtocols: The agent protocols of the HTTP API.

ai_protocols^Optional

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

Property aiProtocols: The AI protocols of the HTTP API.

auth_config^Optional

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

Property authConfig: The authentication configuration.

base_path^Optional

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

Property basePath: The base path of the HTTP API.

belong_gateway_id^Optional

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

Property belongGatewayId: The gateway ID that the HTTP API belongs to.

builtin_route_names^Optional

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

Property builtinRouteNames: The builtin route names.

deploy_configs^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeployConfigsProperty]]]

Property deployConfigs: The deploy configurations of the HTTP API.

description^Optional

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

Property description: The description of the HTTP API.

enable_auth^Optional

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

Property enableAuth: Whether to enable authentication.

first_byte_timeout^Optional

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

Property firstByteTimeout: The first byte timeout.

ingress_config^Optional

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

Property ingressConfig: The ingress configuration of the HTTP API.

model_category^Optional

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

Property modelCategory: The model category.

only_change_config^Optional

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

Property onlyChangeConfig: Whether to only change config without triggering redeployment.

True means only modify configuration without triggering redeployment.

protocols^Optional

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

Property protocols: The protocols supported by the HTTP API.

remove_base_path_on_forward^Optional

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

Property removeBasePathOnForward: Whether to remove the base path on forward.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

strategy^Optional

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

Property strategy: The strategy of the HTTP API.

type^Optional

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

Property type: The type of the HTTP API.

version_config^Optional

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

Property versionConfig: The version configuration of the HTTP API.

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.HttpApi.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_http_api_id^Required

attr_http_api_id: typing.Union[str, IResolvable]

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

Attribute HttpApiId: The ID of the HTTP API.

props^Required

props: HttpApiProps

• Type: HttpApiProps