Skip to content

IApiAttachment

Represents a ApiAttachment.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_http_api_id typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpApiId: The ID of the HTTP API.
attr_route_id typing.Union[str, ros_cdk_core.IResolvable] Attribute RouteId: The route ID.
props ApiAttachmentProps No description.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.

envRequired 

env: IResourceEnvironment
  • Type: 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 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

attr_http_api_idRequired 

attr_http_api_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HttpApiId: The ID of the HTTP API.

attr_route_idRequired 

attr_route_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RouteId: The route ID.

When publishing an HTTP API route, it must be passed in.

propsRequired 

props: ApiAttachmentProps