Skip to content

MessageCallback

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 an event notification.

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
callbackType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property callbackType: Callback method.
appId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appId: App ID.
authKey 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.
authSwitch 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property callbackUrl: Callback address.
eventTypeList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property eventTypeList: Callback event type.
mnsEndpoint 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.
mnsQueueName 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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

callbackTypeRequired

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

Property callbackType: Callback method.

appIdOptional

  • 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.

authKeyOptional

  • 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.

authSwitchOptional

  • 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.

callbackUrlOptional

  • 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.

eventTypeListOptional

  • 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.

mnsEndpointOptional

  • 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.

mnsQueueNameOptional

  • 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

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.vod.MessageCallback;
MessageCallback.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAppId com.aliyun.ros.cdk.core.IResolvable Attribute AppId: appid.
attrAuthKey com.aliyun.ros.cdk.core.IResolvable Attribute AuthKey: auth key.
attrAuthSwitch com.aliyun.ros.cdk.core.IResolvable Attribute AuthSwitch: auth swith.
attrCallbackType com.aliyun.ros.cdk.core.IResolvable Attribute CallbackType: callback type.
attrCallbackUrl com.aliyun.ros.cdk.core.IResolvable Attribute CallbackUrl: url.
attrEventTypeList com.aliyun.ros.cdk.core.IResolvable Attribute EventTypeList: event type.
attrMnsEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute MnsEndpoint: mns endpoint.
attrMnsQueueName com.aliyun.ros.cdk.core.IResolvable Attribute MnsQueueName: queue name.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAppIdRequired 

public IResolvable getAttrAppId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AppId: appid.

attrAuthKeyRequired 

public IResolvable getAttrAuthKey();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AuthKey: auth key.

attrAuthSwitchRequired 

public IResolvable getAttrAuthSwitch();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AuthSwitch: auth swith.

attrCallbackTypeRequired 

public IResolvable getAttrCallbackType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CallbackType: callback type.

attrCallbackUrlRequired 

public IResolvable getAttrCallbackUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CallbackUrl: url.

attrEventTypeListRequired 

public IResolvable getAttrEventTypeList();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EventTypeList: event type.

attrMnsEndpointRequired 

public IResolvable getAttrMnsEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MnsEndpoint: mns endpoint.

attrMnsQueueNameRequired 

public IResolvable getAttrMnsQueueName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MnsQueueName: queue name.