Skip to content

IHttpApi

  • Extends: com.aliyun.ros.cdk.core.IResource

  • Implemented By: com.aliyun.ros.cdk.apig.datasource.HttpApi, com.aliyun.ros.cdk.apig.datasource.IHttpApi

Represents a HttpApi.

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node for this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
attrBasePath java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BasePath: The base path of the API.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: Description of API.
attrHttpApiId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpApiId: The ID of the API.
attrHttpApiName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HttpApiName: The name of the API.
attrProtocols java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Protocols: List of API Access Protocols.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Type: The type of HTTP API.
props HttpApiProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node for this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


attrBasePathRequired

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

Attribute BasePath: The base path of the API.


attrDescriptionRequired

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

Attribute Description: Description of API.


attrHttpApiIdRequired

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

Attribute HttpApiId: The ID of the API.


attrHttpApiNameRequired

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

Attribute HttpApiName: The name of the API.


attrProtocolsRequired

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

Attribute Protocols: List of API Access Protocols.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attrTypeRequired

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

Attribute Type: The type of HTTP API.


propsRequired

public HttpApiProps getProps();