ApiDestination

• Implements: IApiDestination

This class encapsulates and extends the ROS resource type ALIYUN::EventBridge::ApiDestination.

Initializers

import ros_cdk_eventbridge
ros_cdk_eventbridge.ApiDestination(
  scope: Construct,
  id: str,
  api_destination_name: typing.Union[str, IResolvable],
  connection_name: typing.Union[str, IResolvable],
  http_api_parameters: typing.Union[IResolvable, HttpApiParametersProperty],
  description: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

api_destination_name^Required

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

Property apiDestinationName: The name of the api.

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

connection_name^Required

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

Property connectionName: The connection configuration name.

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

• Tip: You must first call the Connection interface to create a Connection configuration. Enter the name of the existing Connection.

http_api_parameters^Required

• Type: typing.Union[ros_cdk_core.IResolvable, HttpApiParametersProperty]

Property httpApiParameters: Configuration information for API endpoints.

description^Optional

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

Property description: The description of the api.

It must be no more than 255 characters.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_eventbridge
ros_cdk_eventbridge.ApiDestination.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_api_destination_name^Required

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_name^Required

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_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: Creation time.

attr_description^Required

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_parameters^Required

attr_http_api_parameters: typing.Union[str, IResolvable]

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

Attribute HttpApiParameters: Configuration information for API endpoints.

props^Required

props: ApiDestinationProps

• Type: ApiDestinationProps