HttpApi

This class encapsulates and extends the ROS resource type ALIYUN::APIG::HttpApi.

Initializers

import com.aliyun.ros.cdk.apig.HttpApi;
HttpApi.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No 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.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

httpApiName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpApiName: The name of the API.

---

protocols^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property protocols: List of API Access Protocols.

---

basePath^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Description of API.

---

type^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.apig.HttpApi;
HttpApi.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrBasePath	com.aliyun.ros.cdk.core.IResolvable	Attribute BasePath: The base path of the API.
attrDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute Description: Description of API.
attrEnvironments	com.aliyun.ros.cdk.core.IResolvable	Attribute Environments: Published Environmental Information of the API.
attrHttpApiId	com.aliyun.ros.cdk.core.IResolvable	Attribute HttpApiId: The ID of the API.
attrHttpApiName	com.aliyun.ros.cdk.core.IResolvable	Attribute HttpApiName: The name of the API.
attrProtocols	com.aliyun.ros.cdk.core.IResolvable	Attribute Protocols: List of API Access Protocols.
attrType	com.aliyun.ros.cdk.core.IResolvable	Attribute Type: The type of HTTP API.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrBasePath^Required

public IResolvable getAttrBasePath();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BasePath: The base path of the API.

---

attrDescription^Required

public IResolvable getAttrDescription();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: Description of API.

---

attrEnvironments^Required

public IResolvable getAttrEnvironments();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Environments: Published Environmental Information of the API.

---

attrHttpApiId^Required

public IResolvable getAttrHttpApiId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute HttpApiId: The ID of the API.

---

attrHttpApiName^Required

public IResolvable getAttrHttpApiName();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute HttpApiName: The name of the API.

---

attrProtocols^Required

public IResolvable getAttrProtocols();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Protocols: List of API Access Protocols.

---

attrType^Required

public IResolvable getAttrType();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Type: The type of HTTP API.

---