RosApiProps

Properties for defining a RosApi.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-api

Initializer

import ros_cdk_apigateway
ros_cdk_apigateway.RosApiProps(
  api_name: typing.Union[str, IResolvable],
  group_id: typing.Union[str, IResolvable],
  request_config: typing.Union[IResolvable, RequestConfigProperty],
  service_config: typing.Union[IResolvable, ServiceConfigProperty],
  visibility: typing.Union[str, IResolvable],
  allow_signature_method: typing.Union[str, IResolvable] = None,
  app_code_auth_type: typing.Union[str, IResolvable] = None,
  auth_type: typing.Union[str, IResolvable] = None,
  const_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ConstParametersProperty]]] = None,
  description: typing.Union[str, IResolvable] = None,
  disable_internet: typing.Union[bool, IResolvable] = None,
  error_code_samples: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ErrorCodeSamplesProperty]]] = None,
  fail_result_sample: typing.Union[str, IResolvable] = None,
  force_nonce_check: typing.Union[bool, IResolvable] = None,
  open_id_connect_config: typing.Union[IResolvable, OpenIdConnectConfigProperty] = None,
  request_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RequestParametersProperty]]] = None,
  result_body_model: typing.Union[str, IResolvable] = None,
  result_descriptions: typing.Union[str, IResolvable] = None,
  result_sample: typing.Union[str, IResolvable] = None,
  result_type: typing.Union[str, IResolvable] = None,
  service_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceParametersProperty]]] = None,
  service_parameters_map: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceParametersMapProperty]]] = None,
  system_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SystemParametersProperty]]] = None,
  tags: typing.List[TagsProperty] = None,
  web_socket_api_type: typing.Union[str, IResolvable] = None
)

Properties

Name	Type	Description
api_name	typing.Union[str, ros_cdk_core.IResolvable]	No description.
group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
request_config	typing.Union[ros_cdk_core.IResolvable, RequestConfigProperty]	No description.
service_config	typing.Union[ros_cdk_core.IResolvable, ServiceConfigProperty]	No description.
visibility	typing.Union[str, ros_cdk_core.IResolvable]	No description.
allow_signature_method	typing.Union[str, ros_cdk_core.IResolvable]	No description.
app_code_auth_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
auth_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
const_parameters	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ConstParametersProperty]]]	No description.
description	typing.Union[str, ros_cdk_core.IResolvable]	No description.
disable_internet	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
error_code_samples	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ErrorCodeSamplesProperty]]]	No description.
fail_result_sample	typing.Union[str, ros_cdk_core.IResolvable]	No description.
force_nonce_check	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
open_id_connect_config	typing.Union[ros_cdk_core.IResolvable, OpenIdConnectConfigProperty]	No description.
request_parameters	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, RequestParametersProperty]]]	No description.
result_body_model	typing.Union[str, ros_cdk_core.IResolvable]	No description.
result_descriptions	typing.Union[str, ros_cdk_core.IResolvable]	No description.
result_sample	typing.Union[str, ros_cdk_core.IResolvable]	No description.
result_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
service_parameters	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServiceParametersProperty]]]	No description.
service_parameters_map	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServiceParametersMapProperty]]]	No description.
system_parameters	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SystemParametersProperty]]]	No description.
tags	typing.List[TagsProperty]	No description.
web_socket_api_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.

---

api_name^Required

api_name: typing.Union[str, IResolvable]

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

---

group_id^Required

group_id: typing.Union[str, IResolvable]

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

---

request_config^Required

request_config: typing.Union[IResolvable, RequestConfigProperty]

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

---

service_config^Required

service_config: typing.Union[IResolvable, ServiceConfigProperty]

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

---

visibility^Required

visibility: typing.Union[str, IResolvable]

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

---

allow_signature_method^Optional

allow_signature_method: typing.Union[str, IResolvable]

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

---

app_code_auth_type^Optional

app_code_auth_type: typing.Union[str, IResolvable]

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

---

auth_type^Optional

auth_type: typing.Union[str, IResolvable]

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

---

const_parameters^Optional

const_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ConstParametersProperty]]]

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

---

description^Optional

description: typing.Union[str, IResolvable]

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

---

disable_internet^Optional

disable_internet: typing.Union[bool, IResolvable]

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

---

error_code_samples^Optional

error_code_samples: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ErrorCodeSamplesProperty]]]

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

---

fail_result_sample^Optional

fail_result_sample: typing.Union[str, IResolvable]

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

---

force_nonce_check^Optional

force_nonce_check: typing.Union[bool, IResolvable]

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

---

open_id_connect_config^Optional

open_id_connect_config: typing.Union[IResolvable, OpenIdConnectConfigProperty]

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

---

request_parameters^Optional

request_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RequestParametersProperty]]]

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

---

result_body_model^Optional

result_body_model: typing.Union[str, IResolvable]

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

---

result_descriptions^Optional

result_descriptions: typing.Union[str, IResolvable]

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

---

result_sample^Optional

result_sample: typing.Union[str, IResolvable]

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

---

result_type^Optional

result_type: typing.Union[str, IResolvable]

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

---

service_parameters^Optional

service_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceParametersProperty]]]

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

---

service_parameters_map^Optional

service_parameters_map: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceParametersMapProperty]]]

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

---

system_parameters^Optional

system_parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SystemParametersProperty]]]

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

---

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

---

web_socket_api_type^Optional

web_socket_api_type: typing.Union[str, IResolvable]

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

---