Skip to content

ApisProps

Properties for defining a Apis.

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

Initializer 

import com.aliyun.ros.cdk.apigateway.datasource.ApisProps;
ApisProps.builder()
//  .apiId(java.lang.String)
//  .apiId(IResolvable)
//  .apiName(java.lang.String)
//  .apiName(IResolvable)
//  .catalogId(java.lang.String)
//  .catalogId(IResolvable)
//  .enableTagAuth(java.lang.Boolean)
//  .enableTagAuth(IResolvable)
//  .groupId(java.lang.String)
//  .groupId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .visibility(java.lang.String)
//  .visibility(IResolvable)
    .build();

Properties

Name Type Description
apiId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property apiId: ID of the specified API.
apiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property apiName: API name (fuzzy matching).
catalogId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property catalogId: Catalog number.
enableTagAuth java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableTagAuth: Enable label validation.
groupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupId: ID of the specified group.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
visibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property visibility: Whether the API is public.

apiIdOptional 

public java.lang.Object getApiId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property apiId: ID of the specified API.

apiNameOptional 

public java.lang.Object getApiName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property apiName: API name (fuzzy matching).

catalogIdOptional 

public java.lang.Object getCatalogId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property catalogId: Catalog number.

enableTagAuthOptional 

public java.lang.Object getEnableTagAuth();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableTagAuth: Enable label validation.

groupIdOptional 

public java.lang.Object getGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property groupId: ID of the specified group.

refreshOptionsOptional 

public java.lang.Object getRefreshOptions();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getVisibility();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property visibility: Whether the API is public.