Skip to content

HttpApi

  • Implements: github.com/alibabacloud-go/ros-cdk/alicloudroscdkapig.datasource.IHttpApi

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapig/datasource"
datasource.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.

scopeRequired

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

idRequired

  • Type: *string

propsRequired


enableResourcePropertyConstraintOptional

  • 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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc 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.

sessionRequired

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

The synthesis session.


AddCondition

func AddCondition(condition RosCondition)

conditionRequired

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

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency

func AddDependency(resource Resource)

resourceRequired

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

AddResourceDesc

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

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

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata

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

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

Static Functions

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

IsConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
Env github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment The environment this resource belongs to.
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 interface{} Attribute BasePath: The base path of the API.
AttrDescription interface{} Attribute Description: Description of API.
AttrHttpApiId interface{} Attribute HttpApiId: The ID of the API.
AttrHttpApiName interface{} Attribute HttpApiName: The name of the API.
AttrProtocols interface{} Attribute Protocols: List of API Access Protocols.
AttrResourceGroupId interface{} Attribute ResourceGroupId: The ID of the resource group.
AttrType interface{} Attribute Type: The type of HTTP API.
Props HttpApiProps No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


EnvRequired

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


RefRequired

func Ref() *string
  • Type: *string

StackRequired

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

The stack in which this resource is defined.


ResourceOptional

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrBasePathRequired

func AttrBasePath() interface{}
  • Type: interface{}

Attribute BasePath: The base path of the API.


AttrDescriptionRequired

func AttrDescription() interface{}
  • Type: interface{}

Attribute Description: Description of API.


AttrHttpApiIdRequired

func AttrHttpApiId() interface{}
  • Type: interface{}

Attribute HttpApiId: The ID of the API.


AttrHttpApiNameRequired

func AttrHttpApiName() interface{}
  • Type: interface{}

Attribute HttpApiName: The name of the API.


AttrProtocolsRequired

func AttrProtocols() interface{}
  • Type: interface{}

Attribute Protocols: List of API Access Protocols.


AttrResourceGroupIdRequired

func AttrResourceGroupId() interface{}
  • Type: interface{}

Attribute ResourceGroupId: The ID of the resource group.


AttrTypeRequired

func AttrType() interface{}
  • Type: interface{}

Attribute Type: The type of HTTP API.


PropsRequired

func Props() HttpApiProps