HttpApi

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapig"
alicloudroscdkapig.NewHttpApi(scope Construct, id *string, props HttpApiProps, enableResourcePropertyConstraint *bool) HttpApi

Name	Type	Description
scope	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct	No description.
id	*string	No description.
props	HttpApiProps	No description.
enableResourcePropertyConstraint	*bool	No description.

---

scope^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

---

AddCondition

func AddCondition(condition RosCondition)

condition^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

---

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

---

AddDependency

func AddDependency(resource Resource)

resource^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

---

AddResourceDesc

func AddResourceDesc(desc *string)

desc^Required

• Type: *string

---

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policy^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

---

GetAtt

func GetAtt(name *string) IResolvable

name^Required

• Type: *string

---

SetMetadata

func SetMetadata(key *string, value interface{})

key^Required

• Type: *string

---

value^Required

• Type: interface{}

---

Static Functions

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

---

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapig"
alicloudroscdkapig.HttpApi_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

x^Required

• Type: interface{}

---

Properties

Name	Type	Description
Node	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode	The construct tree node associated with this construct.
Ref	*string	No description.
Stack	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack	The stack in which this resource is defined.
Resource	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource	No description.
AttrBasePath	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute BasePath: The base path of the API.
AttrDescription	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute Description: Description of API.
AttrEnvironments	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute Environments: Published Environmental Information of the API.
AttrHttpApiId	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute HttpApiId: The ID of the API.
AttrHttpApiName	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute HttpApiName: The name of the API.
AttrProtocols	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute Protocols: List of API Access Protocols.
AttrType	github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable	Attribute Type: The type of HTTP API.

---

Node^Required

func Node() ConstructNode

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

---

Ref^Required

func Ref() *string

• Type: *string

---

Stack^Required

func Stack() Stack

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.

---

Resource^Optional

func Resource() RosResource

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

---

AttrBasePath^Required

func AttrBasePath() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute BasePath: The base path of the API.

---

AttrDescription^Required

func AttrDescription() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Description: Description of API.

---

AttrEnvironments^Required

func AttrEnvironments() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Environments: Published Environmental Information of the API.

---

AttrHttpApiId^Required

func AttrHttpApiId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute HttpApiId: The ID of the API.

---

AttrHttpApiName^Required

func AttrHttpApiName() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute HttpApiName: The name of the API.

---

AttrProtocols^Required

func AttrProtocols() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Protocols: List of API Access Protocols.

---

AttrType^Required

func AttrType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Type: The type of HTTP API.

---