Skip to content

RequestParametersProperty

Initializer 

import ros_cdk_apigateway
ros_cdk_apigateway.RosApi.RequestParametersProperty(
  api_parameter_name: typing.Union[str, IResolvable],
  location: typing.Union[str, IResolvable],
  parameter_type: typing.Union[str, IResolvable],
  required: typing.Union[str, IResolvable],
  default_value: typing.Union[str, IResolvable] = None,
  demo_value: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  doc_order: typing.Union[typing.Union[int, float], IResolvable] = None,
  doc_show: typing.Union[str, IResolvable] = None,
  enum_value: typing.Union[str, IResolvable] = None,
  json_scheme: typing.Union[str, IResolvable] = None,
  max_length: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_value: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_length: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_value: typing.Union[typing.Union[int, float], IResolvable] = None,
  regular_expression: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
api_parameter_name typing.Union[str, ros_cdk_core.IResolvable] No description.
location typing.Union[str, ros_cdk_core.IResolvable] No description.
parameter_type typing.Union[str, ros_cdk_core.IResolvable] No description.
required typing.Union[str, ros_cdk_core.IResolvable] No description.
default_value typing.Union[str, ros_cdk_core.IResolvable] No description.
demo_value typing.Union[str, ros_cdk_core.IResolvable] No description.
description typing.Union[str, ros_cdk_core.IResolvable] No description.
doc_order typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
doc_show typing.Union[str, ros_cdk_core.IResolvable] No description.
enum_value typing.Union[str, ros_cdk_core.IResolvable] No description.
json_scheme typing.Union[str, ros_cdk_core.IResolvable] No description.
max_length typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
max_value typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
min_length typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
min_value typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
regular_expression typing.Union[str, ros_cdk_core.IResolvable] No description.

api_parameter_nameRequired 

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

locationRequired 

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

parameter_typeRequired 

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

requiredRequired 

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

default_valueOptional 

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

demo_valueOptional 

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

descriptionOptional 

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

doc_orderOptional 

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

doc_showOptional 

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

enum_valueOptional 

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

json_schemeOptional 

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

max_lengthOptional 

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

max_valueOptional 

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

min_lengthOptional 

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

min_valueOptional 

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

regular_expressionOptional 

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