ApiDestination

• Implements: IApiDestination

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

Initializers

import com.aliyun.ros.cdk.eventbridge.ApiDestination;
ApiDestination.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .apiDestinationName(java.lang.String)
    .apiDestinationName(IResolvable)
    .connectionName(java.lang.String)
    .connectionName(IResolvable)
    .httpApiParameters(IResolvable)
    .httpApiParameters(HttpApiParametersProperty)
//  .description(java.lang.String)
//  .description(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

apiDestinationName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property apiDestinationName: The name of the api.

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

connectionName^Required

• Type: java.lang.String OR com.aliyun.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.

httpApiParameters^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR HttpApiParametersProperty

Property httpApiParameters: Configuration information for API endpoints.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the api.

It must be no more than 255 characters.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.eventbridge.ApiDestination;
ApiDestination.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrApiDestinationName^Required

public java.lang.Object getAttrApiDestinationName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ApiDestinationName: The name of the api.

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

attrConnectionName^Required

public java.lang.Object getAttrConnectionName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionName: The connection configuration name.

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

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: Creation time.

attrDescription^Required

public java.lang.Object getAttrDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the api.

It must be no more than 255 characters.

attrHttpApiParameters^Required

public java.lang.Object getAttrHttpApiParameters();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HttpApiParameters: Configuration information for API endpoints.

props^Required

public ApiDestinationProps getProps();

• Type: ApiDestinationProps