HttpApi

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

Initializers

import { HttpApi } from '@alicloud/ros-cdk-apig'
new HttpApi(scope: Construct, id: string, props: HttpApiProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	HttpApiProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: HttpApiProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { HttpApi } from '@alicloud/ros-cdk-apig'
HttpApi.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

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

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrBasePath^Required

public readonly attrBasePath: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute BasePath: The base path of the API.

---

attrDescription^Required

public readonly attrDescription: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: Description of API.

---

attrEnvironments^Required

public readonly attrEnvironments: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Environments: Published Environmental Information of the API.

---

attrHttpApiId^Required

public readonly attrHttpApiId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HttpApiId: The ID of the API.

---

attrHttpApiName^Required

public readonly attrHttpApiName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HttpApiName: The name of the API.

---

attrProtocols^Required

public readonly attrProtocols: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Protocols: List of API Access Protocols.

---

attrType^Required

public readonly attrType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Type: The type of HTTP API.

---