IHttpApi

• Extends: @alicloud/ros-cdk-core.IResource

• Implemented By: @alicloud/ros-cdk-apig.datasource.HttpApi, @alicloud/ros-cdk-apig.datasource.IHttpApi

Represents a HttpApi.

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node for this construct.

env^Required

public readonly env: IResourceEnvironment;

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

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

attrBasePath^Required

public readonly attrBasePath: string | IResolvable;

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

Attribute BasePath: The base path of the API.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

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

Attribute Description: Description of API.

attrHttpApiId^Required

public readonly attrHttpApiId: string | IResolvable;

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

Attribute HttpApiId: The ID of the API.

attrHttpApiName^Required

public readonly attrHttpApiName: string | IResolvable;

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

Attribute HttpApiName: The name of the API.

attrProtocols^Required

public readonly attrProtocols: string | IResolvable;

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

Attribute Protocols: List of API Access Protocols.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

attrType^Required

public readonly attrType: string | IResolvable;

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

Attribute Type: The type of HTTP API.

props^Required

public readonly props: HttpApiProps;

• Type: HttpApiProps