Skip to content

ApisProps

Properties for defining a Apis.

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

Initializer 

import { datasource } from '@alicloud/ros-cdk-apigateway'
const apisProps: datasource.ApisProps = { ... }

Properties

Name Type Description
apiId string | @alicloud/ros-cdk-core.IResolvable Property apiId: ID of the specified API.
apiName string | @alicloud/ros-cdk-core.IResolvable Property apiName: API name (fuzzy matching).
catalogId string | @alicloud/ros-cdk-core.IResolvable Property catalogId: Catalog number.
enableTagAuth boolean | @alicloud/ros-cdk-core.IResolvable Property enableTagAuth: Enable label validation.
groupId string | @alicloud/ros-cdk-core.IResolvable Property groupId: ID of the specified group.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
visibility string | @alicloud/ros-cdk-core.IResolvable Property visibility: Whether the API is public.

apiIdOptional 

public readonly apiId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property apiId: ID of the specified API.

apiNameOptional 

public readonly apiName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property apiName: API name (fuzzy matching).

catalogIdOptional 

public readonly catalogId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property catalogId: Catalog number.

enableTagAuthOptional 

public readonly enableTagAuth: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableTagAuth: Enable label validation.

groupIdOptional 

public readonly groupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property groupId: ID of the specified group.

refreshOptionsOptional 

public readonly refreshOptions: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly visibility: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property visibility: Whether the API is public.