Skip to content

Subscription

This class encapsulates and extends the ROS resource type DATASOURCE::MNS::Subscription.

Initializers 

import com.aliyun.ros.cdk.mns.datasource.Subscription;
Subscription.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .subscriptionName(java.lang.String)
    .subscriptionName(IResolvable)
    .topicName(java.lang.String)
    .topicName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
subscriptionName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property subscriptionName: The name of the subscription.
topicName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topicName: The name of the topic.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

subscriptionNameRequired

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

Property subscriptionName: The name of the subscription.

topicNameRequired

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

Property topicName: The name of the topic.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.mns.datasource.Subscription;
Subscription.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.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the subscription was created.
attrEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute Endpoint: The endpoint that is used by the subscriber to receive messages.
attrFilterTag com.aliyun.ros.cdk.core.IResolvable Attribute FilterTag: Describes the labels by which messages are filtered in this subscription (only messages with consistent labels are pushed).
attrLastModifyTime com.aliyun.ros.cdk.core.IResolvable Attribute LastModifyTime: The time when the subscription was last modified.
attrNotifyContentFormat com.aliyun.ros.cdk.core.IResolvable Attribute NotifyContentFormat: The format of the message that is pushed to the endpoint.
attrNotifyStrategy com.aliyun.ros.cdk.core.IResolvable Attribute NotifyStrategy: The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint.
attrSubscriptionName com.aliyun.ros.cdk.core.IResolvable Attribute SubscriptionName: The name of the subscription.
attrSubscriptionUrl com.aliyun.ros.cdk.core.IResolvable Attribute SubscriptionURL: TThe URL of the subscription.
attrTopicName com.aliyun.ros.cdk.core.IResolvable Attribute TopicName: The name of the topic.
attrTopicOwner com.aliyun.ros.cdk.core.IResolvable Attribute TopicOwner: The owner of the topic.

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

attrCreateTimeRequired 

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

Attribute CreateTime: The time when the subscription was created.

attrEndpointRequired 

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

Attribute Endpoint: The endpoint that is used by the subscriber to receive messages.

attrFilterTagRequired 

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

Attribute FilterTag: Describes the labels by which messages are filtered in this subscription (only messages with consistent labels are pushed).

attrLastModifyTimeRequired 

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

Attribute LastModifyTime: The time when the subscription was last modified.

attrNotifyContentFormatRequired 

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

Attribute NotifyContentFormat: The format of the message that is pushed to the endpoint.

attrNotifyStrategyRequired 

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

Attribute NotifyStrategy: The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint.

attrSubscriptionNameRequired 

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

Attribute SubscriptionName: The name of the subscription.

attrSubscriptionUrlRequired 

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

Attribute SubscriptionURL: TThe URL of the subscription.

attrTopicNameRequired 

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

Attribute TopicName: The name of the topic.

attrTopicOwnerRequired 

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

Attribute TopicOwner: The owner of the topic.