HttpApi

This class encapsulates and extends the ROS resource type ALIYUN::APIG::HttpApi.

Initializers

import ros_cdk_apig
ros_cdk_apig.HttpApi(
  scope: Construct,
  id: str,
  http_api_name: typing.Union[str, IResolvable],
  protocols: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  base_path: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
http_api_name	typing.Union[str, ros_cdk_core.IResolvable]	Property httpApiName: The name of the API.
protocols	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property protocols: List of API Access Protocols.
base_path	typing.Union[str, ros_cdk_core.IResolvable]	Property basePath: The base path of the API should start with a \/.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: Description of API.
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.
enable_resource_property_constraint	bool	No description.

---

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 API.

---

protocols^Required

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

Property protocols: List of API Access Protocols.

---

base_path^Optional

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

Property basePath: The base path of the API should start with a \/.

---

description^Optional

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

Property description: Description of API.

---

type^Optional

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

Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

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

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_base_path	ros_cdk_core.IResolvable	Attribute BasePath: The base path of the API.
attr_description	ros_cdk_core.IResolvable	Attribute Description: Description of API.
attr_environments	ros_cdk_core.IResolvable	Attribute Environments: Published Environmental Information of the API.
attr_http_api_id	ros_cdk_core.IResolvable	Attribute HttpApiId: The ID of the API.
attr_http_api_name	ros_cdk_core.IResolvable	Attribute HttpApiName: The name of the API.
attr_protocols	ros_cdk_core.IResolvable	Attribute Protocols: List of API Access Protocols.
attr_type	ros_cdk_core.IResolvable	Attribute Type: The type of HTTP API.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_base_path^Required

attr_base_path: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BasePath: The base path of the API.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: Description of API.

---

attr_environments^Required

attr_environments: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Environments: Published Environmental Information of the API.

---

attr_http_api_id^Required

attr_http_api_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HttpApiId: The ID of the API.

---

attr_http_api_name^Required

attr_http_api_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HttpApiName: The name of the API.

---

attr_protocols^Required

attr_protocols: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Protocols: List of API Access Protocols.

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: The type of HTTP API.

---