Skip to content

HttpApiProps

Properties for defining a HttpApi.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-httpapi

Initializer 

import com.aliyun.ros.cdk.apig.HttpApiProps;
HttpApiProps.builder()
    .httpApiName(java.lang.String)
    .httpApiName(IResolvable)
    .protocols(IResolvable)
    .protocols(java.util.List<java.lang.String)
    .protocols(IResolvable>)
//  .basePath(java.lang.String)
//  .basePath(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .type(java.lang.String)
//  .type(IResolvable)
    .build();

Properties

Name Type Description
httpApiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property httpApiName: The name of the API.
protocols com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property protocols: List of API Access Protocols.
basePath java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property basePath: The base path of the API should start with a \/.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of API.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.

httpApiNameRequired 

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

Property httpApiName: The name of the API.

protocolsRequired 

public java.lang.Object getProtocols();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property protocols: List of API Access Protocols.

basePathOptional 

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

Property basePath: The base path of the API should start with a \/.

descriptionOptional 

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

Property description: Description of API.

typeOptional 

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

Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress.