Subscription

• Implements: ISubscription

This class encapsulates and extends the ROS resource type ALIYUN::MNS::Subscription, which is used to describe a subscription relationship, including the subscribed topic and the endpoint that the subscriber uses to receive messages.

Initializers

import com.aliyun.ros.cdk.mns.Subscription;
Subscription.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .endpoint(java.lang.String)
    .endpoint(IResolvable)
    .subscriptionName(java.lang.String)
    .subscriptionName(IResolvable)
    .topicName(java.lang.String)
    .topicName(IResolvable)
//  .dlqPolicy(IResolvable)
//  .dlqPolicy(DlqPolicyProperty)
//  .filterTag(java.lang.String)
//  .filterTag(IResolvable)
//  .notifyContentFormat(java.lang.String)
//  .notifyContentFormat(IResolvable)
//  .notifyStrategy(java.lang.String)
//  .notifyStrategy(IResolvable)
//  .pushType(java.lang.String)
//  .pushType(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

endpoint^Required

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

Property endpoint: The message delivery endpoint.

The format varies based on the PushType value:

• If PushType is http: An HTTP/HTTPS callback URL, such as http:\/\/example.com\/callback or https:\/\/example.com\/callback.
• If PushType is queue: The ARN of the destination queue, in the format acs:mns:{RegionId}:{account ID}:queues\/{QueueName}.
• If PushType is dm: The endpoint for email push, in the fixed format smq-ep:dm:{account ID}:__dynamic. Replace {account ID} with your account ID.
• If PushType is dysms: The endpoint for SMS push, in the format smq-ep:dysms:{account ID}:{MobileNumber}.
• If PushType is kafka: The Kafka push endpoint.
• If PushType is fc: The endpoint for Function Compute, in the format acs:fc:{RegionId}:{account ID}:services\/{ServiceName}\/functions\/{FunctionName}.
• If PushType is eventbus: The endpoint for EventBridge, in the format acs:eventbridge:{RegionId}:{account ID}:eventbus\/{EventBusName}.

subscriptionName^Required

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

Property subscriptionName: Subscription name.

topicName^Required

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

Property topicName: Topic name.

dlqPolicy^Optional

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

Property dlqPolicy: Dead-letter queue policy.

filterTag^Optional

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

Property filterTag: Message filter tag in the created subscription (Only messages with consistent tags are pushed.) The value is a string of no more than 16 characters. The default value is no message filter.

notifyContentFormat^Optional

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

Property notifyContentFormat: Format of the message content pushed to the endpoint.

XML, JSON, or SIMPLIFIED; default value: XML. For details about message formats, refer to Basic Concepts/NotifyContentFormat.

notifyStrategy^Optional

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

Property notifyStrategy: Retry policy that will be applied when an error occurs during message push to the endpoint.

BACKOFF_RETRY or EXPONENTIAL_DECAY_RETRY; default value: BACKOFF_RETRY. For details about retry policies, refer to Basic Concepts/NotifyStrategy.

pushType^Optional

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

Property pushType: Push type of the created subscription.

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.mns.Subscription;
Subscription.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

attrSubscriptionName^Required

public java.lang.Object getAttrSubscriptionName();

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

Attribute SubscriptionName: Subscription name.

attrSubscriptionUrl^Required

public java.lang.Object getAttrSubscriptionUrl();

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

Attribute SubscriptionUrl: URL of created subscription.

attrTopicName^Required

public java.lang.Object getAttrTopicName();

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

Attribute TopicName: Topic name.

props^Required

public SubscriptionProps getProps();

• Type: SubscriptionProps