Skip to content

IApi

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

  • Implemented By: Api, IApi

Represents a Api.

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node for this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
attrApiId string | @alicloud/ros-cdk-core.IResolvable Attribute ApiId: The id of the API.
attrArn string | @alicloud/ros-cdk-core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN).
props ApiProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node for this construct.


envRequired

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.


stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


attrApiIdRequired

public readonly attrApiId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ApiId: The id of the API.


attrArnRequired

public readonly attrArn: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).


propsRequired

public readonly props: ApiProps;