Skip to content

IHttpApi

  • Extends: ros_cdk_core.IResource

  • Implemented By: ros_cdk_apig.datasource.HttpApi, ros_cdk_apig.datasource.IHttpApi

Represents a HttpApi.

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_base_path typing.Union[str, ros_cdk_core.IResolvable] Attribute BasePath: The base path of the API.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: Description of API.
attr_http_api_id typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpApiId: The ID of the API.
attr_http_api_name typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpApiName: The name of the API.
attr_protocols typing.Union[str, ros_cdk_core.IResolvable] Attribute Protocols: List of API Access Protocols.
attr_resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceGroupId: The ID of the resource group.
attr_type typing.Union[str, ros_cdk_core.IResolvable] Attribute Type: The type of HTTP API.
props HttpApiProps 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_base_pathRequired 

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

Attribute BasePath: The base path of the API.

attr_descriptionRequired 

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

Attribute Description: Description of API.

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 API.

attr_http_api_nameRequired 

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

Attribute HttpApiName: The name of the API.

attr_protocolsRequired 

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

Attribute Protocols: List of API Access Protocols.

attr_resource_group_idRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attr_typeRequired 

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

Attribute Type: The type of HTTP API.

propsRequired 

props: HttpApiProps