Skip to content

IApiDestination

Represents a ApiDestination.

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_api_destination_name typing.Union[str, ros_cdk_core.IResolvable] Attribute ApiDestinationName: The name of the api.
attr_connection_name typing.Union[str, ros_cdk_core.IResolvable] Attribute ConnectionName: The connection configuration name.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: Creation time.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The description of the api.
attr_http_api_parameters typing.Union[str, ros_cdk_core.IResolvable] Attribute HttpApiParameters: Configuration information for API endpoints.
props ApiDestinationProps 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_api_destination_nameRequired 

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

Attribute ApiDestinationName: The name of the api.

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

attr_connection_nameRequired 

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

Attribute ConnectionName: The connection configuration name.

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

attr_create_timeRequired 

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

Attribute CreateTime: Creation time.

attr_descriptionRequired 

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

Attribute Description: The description of the api.

It must be no more than 255 characters.

attr_http_api_parametersRequired 

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

Attribute HttpApiParameters: Configuration information for API endpoints.

propsRequired 

props: ApiDestinationProps