HttpApi

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Apig;
new HttpApi(Construct Scope, string Id, HttpApiProps Props, bool EnableResourcePropertyConstraint = null);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	No description.
Id	string	No description.
Props	HttpApiProps	No description.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

---

Id^Required

• Type: string

---

Props^Required

• Type: HttpApiProps

---

EnableResourcePropertyConstraint^Optional

• Type: bool

---

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

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

---

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

---

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

---

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

---

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

Static Functions

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

---

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Apig;
HttpApi.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode	The construct tree node associated with this construct.
Ref	string	No description.
Stack	AlibabaCloud.SDK.ROS.CDK.Core.Stack	The stack in which this resource is defined.
Resource	AlibabaCloud.SDK.ROS.CDK.Core.RosResource	No description.
AttrBasePath	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute BasePath: The base path of the API.
AttrDescription	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute Description: Description of API.
AttrEnvironments	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute Environments: Published Environmental Information of the API.
AttrHttpApiId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute HttpApiId: The ID of the API.
AttrHttpApiName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute HttpApiName: The name of the API.
AttrProtocols	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute Protocols: List of API Access Protocols.
AttrType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute Type: The type of HTTP API.

---

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

---

Ref^Required

public string Ref { get; }

• Type: string

---

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

---

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

---

AttrBasePath^Required

public IResolvable AttrBasePath { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute BasePath: The base path of the API.

---

AttrDescription^Required

public IResolvable AttrDescription { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Description: Description of API.

---

AttrEnvironments^Required

public IResolvable AttrEnvironments { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Environments: Published Environmental Information of the API.

---

AttrHttpApiId^Required

public IResolvable AttrHttpApiId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute HttpApiId: The ID of the API.

---

AttrHttpApiName^Required

public IResolvable AttrHttpApiName { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute HttpApiName: The name of the API.

---

AttrProtocols^Required

public IResolvable AttrProtocols { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Protocols: List of API Access Protocols.

---

AttrType^Required

public IResolvable AttrType { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Type: The type of HTTP API.

---