Skip to content

ApisProps

Properties for defining a Apis.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-apigateway-apis

Initializer 

from ros_cdk_apigateway import datasource
datasource.ApisProps(
  api_id: typing.Union[str, IResolvable] = None,
  api_name: typing.Union[str, IResolvable] = None,
  catalog_id: typing.Union[str, IResolvable] = None,
  enable_tag_auth: typing.Union[bool, IResolvable] = None,
  group_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  visibility: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
api_id typing.Union[str, ros_cdk_core.IResolvable] Property apiId: ID of the specified API.
api_name typing.Union[str, ros_cdk_core.IResolvable] Property apiName: API name (fuzzy matching).
catalog_id typing.Union[str, ros_cdk_core.IResolvable] Property catalogId: Catalog number.
enable_tag_auth typing.Union[bool, ros_cdk_core.IResolvable] Property enableTagAuth: Enable label validation.
group_id typing.Union[str, ros_cdk_core.IResolvable] Property groupId: ID of the specified group.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
visibility typing.Union[str, ros_cdk_core.IResolvable] Property visibility: Whether the API is public.

api_idOptional 

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

Property apiId: ID of the specified API.

api_nameOptional 

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

Property apiName: API name (fuzzy matching).

catalog_idOptional 

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

Property catalogId: Catalog number.

enable_tag_authOptional 

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

Property enableTagAuth: Enable label validation.

group_idOptional 

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

Property groupId: ID of the specified group.

refresh_optionsOptional 

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

visibilityOptional 

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

Property visibility: Whether the API is public.