ApiDestination

• Implements: IApiDestination

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

Initializers

import { ApiDestination } from '@alicloud/ros-cdk-eventbridge'
new ApiDestination(scope: Construct, id: string, props: ApiDestinationProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: ApiDestinationProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { ApiDestination } from '@alicloud/ros-cdk-eventbridge'
ApiDestination.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrApiDestinationName^Required

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.

attrConnectionName^Required

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.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: Creation time.

attrDescription^Required

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.

attrHttpApiParameters^Required

public readonly attrHttpApiParameters: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute HttpApiParameters: Configuration information for API endpoints.

props^Required

public readonly props: ApiDestinationProps;

• Type: ApiDestinationProps