MessageCallback

• Implements: IMessageCallback

This class encapsulates and extends the ROS resource type ALIYUN::VOD::MessageCallback, which is used to configure the callback method, callback URL, and event types for event notifications.

Initializers

import com.aliyun.ros.cdk.vod.MessageCallback;
MessageCallback.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .callbackType(java.lang.String)
    .callbackType(IResolvable)
//  .appId(java.lang.String)
//  .appId(IResolvable)
//  .authKey(java.lang.String)
//  .authKey(IResolvable)
//  .authSwitch(java.lang.String)
//  .authSwitch(IResolvable)
//  .callbackUrl(java.lang.String)
//  .callbackUrl(IResolvable)
//  .eventTypeList(java.lang.String)
//  .eventTypeList(IResolvable)
//  .mnsEndpoint(java.lang.String)
//  .mnsEndpoint(IResolvable)
//  .mnsQueueName(java.lang.String)
//  .mnsQueueName(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

callbackType^Required

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

Property callbackType: Callback method.

appId^Optional

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

Property appId: App ID.

If it is not passed, it is the ID of the default application of the system, with a fixed value: app-1000000.

authKey^Optional

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

Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers.

This parameter can be set when the callback method is HTTP.

authSwitch^Optional

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

Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP.

callbackUrl^Optional

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

Property callbackUrl: Callback address.

When the callback method is HTTP, this parameter needs to be set. The length of the callback address URL cannot exceed 256 bytes, and setting multiple callback addresses is not supported.

eventTypeList^Optional

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

Property eventTypeList: Callback event type.

When the value is empty, all message notifications are turned off, and when the value is ALL, all message notifications are turned on. You can also specify to enable certain message notifications, and use a comma (,) to separate multiple event types.

mnsEndpoint^Optional

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

Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint.

You can log in to the message service console and click the Get Endpoint button in the upper right corner to get it.

mnsQueueName^Optional

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

Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console.

When the callback method is MNS, this parameter needs to be set.

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.vod.MessageCallback;
MessageCallback.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

attrAppId^Required

public java.lang.Object getAttrAppId();

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

Attribute AppId: appid.

attrAuthKey^Required

public java.lang.Object getAttrAuthKey();

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

Attribute AuthKey: auth key.

attrAuthSwitch^Required

public java.lang.Object getAttrAuthSwitch();

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

Attribute AuthSwitch: auth swith.

attrCallbackType^Required

public java.lang.Object getAttrCallbackType();

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

Attribute CallbackType: callback type.

attrCallbackUrl^Required

public java.lang.Object getAttrCallbackUrl();

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

Attribute CallbackUrl: url.

attrEventTypeList^Required

public java.lang.Object getAttrEventTypeList();

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

Attribute EventTypeList: event type.

attrMnsEndpoint^Required

public java.lang.Object getAttrMnsEndpoint();

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

Attribute MnsEndpoint: mns endpoint.

attrMnsQueueName^Required

public java.lang.Object getAttrMnsQueueName();

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

Attribute MnsQueueName: queue name.

props^Required

public MessageCallbackProps getProps();

• Type: MessageCallbackProps