Skip to content

IApiDestination

Represents a ApiDestination.

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.
attrApiDestinationName string | @alicloud/ros-cdk-core.IResolvable Attribute ApiDestinationName: The name of the api.
attrConnectionName string | @alicloud/ros-cdk-core.IResolvable Attribute ConnectionName: The connection configuration name.
attrCreateTime string | @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Creation time.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the api.
attrHttpApiParameters string | @alicloud/ros-cdk-core.IResolvable Attribute HttpApiParameters: Configuration information for API endpoints.
props ApiDestinationProps 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.


attrApiDestinationNameRequired

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

Attribute ApiDestinationName: The name of the api.

The maximum length is 127 characters. Minimum length 2 characters.


attrConnectionNameRequired

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

Attribute ConnectionName: The connection configuration name.

The maximum length is 127 characters. Minimum length 2 characters.


attrCreateTimeRequired

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

Attribute CreateTime: Creation time.


attrDescriptionRequired

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

Attribute Description: The description of the api.

It must be no more than 255 characters.


attrHttpApiParametersRequired

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

Attribute HttpApiParameters: Configuration information for API endpoints.


propsRequired

public readonly props: ApiDestinationProps;