RosApi

This class is a base encapsulation around the ROS resource type ALIYUN::ApiGateway::Api, which is used to create an API.

Initializers

import ros_cdk_apigateway
ros_cdk_apigateway.RosApi(
  scope: Construct,
  id: str,
  api_name: typing.Union[str, IResolvable],
  group_id: typing.Union[str, IResolvable],
  request_config: typing.Union[IResolvable, RequestConfigProperty],
  result_sample: typing.Union[str, IResolvable],
  result_type: typing.Union[str, IResolvable],
  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,
  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,
  enable_resource_property_constraint: bool
)

Name	Type	Description
scope	ros_cdk_core.Construct	- scope in which this resource is defined.
id	str	- scoped id of the resource.
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.
result_sample	typing.Union[str, ros_cdk_core.IResolvable]	No description.
result_type	typing.Union[str, ros_cdk_core.IResolvable]	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.
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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

---

id^Required

• Type: str

scoped id of the resource.

---

api_name^Required

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

---

group_id^Required

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

---

request_config^Required

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

---

result_sample^Required

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

---

result_type^Required

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

---

service_config^Required

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

---

visibility^Required

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

---

allow_signature_method^Optional

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

---

app_code_auth_type^Optional

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

---

auth_type^Optional

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

---

const_parameters^Optional

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

---

description^Optional

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

---

disable_internet^Optional

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

---

error_code_samples^Optional

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

---

fail_result_sample^Optional

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

---

force_nonce_check^Optional

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

---

open_id_connect_config^Optional

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

---

request_parameters^Optional

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

---

result_body_model^Optional

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

---

result_descriptions^Optional

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

---

service_parameters^Optional

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

---

service_parameters_map^Optional

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

---

system_parameters^Optional

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

---

tags^Optional

• Type: typing.List[TagsProperty]

---

web_socket_api_type^Optional

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

---

enable_resource_property_constraint^Required

• 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.
override_logical_id	Overrides the auto-generated logical ID with a specific ID.
add_condition	No description.
add_count	No description.
add_deletion_override	Syntactic sugar for addOverride(path, undefined).
add_depends_on	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
add_desc	No description.
add_meta_data	No description.
add_override	Adds an override to the synthesized ROS resource.
add_property_deletion_override	Adds an override that deletes the value of a property from the resource definition.
add_property_override	Adds an override to a resource property.
add_ros_dependency	No description.
apply_removal_policy	Sets the deletion policy of the resource based on the removal policy specified.
get_att	Returns a token for an runtime attribute of this resource.

---

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.

---

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

---

add_condition

def add_condition(
  con: RosCondition
) -> None

con^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_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

---

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

• Type: ros_cdk_core.RosResource

---

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

add_meta_data

def add_meta_data(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

value^Required

• Type: typing.Any

The value.

Could be primitive or complex.

---

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_path^Required

• Type: str

The path to the property.

---

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_path^Required

• Type: str

The path of the property.

---

value^Required

• Type: typing.Any

The value.

---

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

apply_to_update_replace_policy^Optional

• Type: bool

---

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_name^Required

• Type: str

The name of the attribute.

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.
is_ros_element	Returns true if a construct is a stack element (i.e. part of the synthesized template).
is_ros_resource	Check whether the given construct is a RosResource.

---

is_construct

import ros_cdk_apigateway
ros_cdk_apigateway.RosApi.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

import ros_cdk_apigateway
ros_cdk_apigateway.RosApi.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

---

is_ros_resource

import ros_cdk_apigateway
ros_cdk_apigateway.RosApi.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
creation_stack	typing.List[str]	No description.
logical_id	str	The logical ID for this stack element.
stack	ros_cdk_core.Stack	The stack in which this element is defined.
ref	str	Return a string that will be resolved to a RosTemplate { Ref } for this element.
ros_options	ros_cdk_core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
ros_resource_type	str	ROS resource type.
attr_api_id	ros_cdk_core.IResolvable	No description.
api_name	typing.Union[str, ros_cdk_core.IResolvable]	No description.
enable_resource_property_constraint	bool	No description.
group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
request_config	typing.Union[ros_cdk_core.IResolvable, RequestConfigProperty]	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_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.
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.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

---

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

ref^Required

ref: str

• Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

---

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

---

attr_api_id^Required

attr_api_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

api_name^Required

api_name: typing.Union[str, IResolvable]

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

---

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

---

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]

---

result_sample^Required

result_sample: typing.Union[str, IResolvable]

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

---

result_type^Required

result_type: typing.Union[str, IResolvable]

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

---

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]

---

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]

---

Constants

Name	Type	Description
ROS_RESOURCE_TYPE_NAME	str	The resource type name for this resource class.

---

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.

---