Skip to content

Subscription

  • Implements: com.aliyun.ros.cdk.mns.datasource.ISubscription

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the subscription was created.
attrEndpoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Endpoint: The endpoint that is used by the subscriber to receive messages.
attrFilterTag java.lang.String OR 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LastModifyTime: The time when the subscription was last modified.
attrNotifyContentFormat java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NotifyContentFormat: The format of the message that is pushed to the endpoint.
attrNotifyStrategy java.lang.String OR 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SubscriptionName: The name of the subscription.
attrSubscriptionUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SubscriptionURL: TThe URL of the subscription.
attrTopicName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TopicName: The name of the topic.
attrTopicOwner java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TopicOwner: The owner of the topic.
props SubscriptionProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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 java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the subscription was created.


attrEndpointRequired

public java.lang.Object getAttrEndpoint();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrFilterTagRequired

public java.lang.Object getAttrFilterTag();
  • Type: java.lang.String OR 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 java.lang.Object getAttrLastModifyTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrNotifyContentFormatRequired

public java.lang.Object getAttrNotifyContentFormat();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrNotifyStrategyRequired

public java.lang.Object getAttrNotifyStrategy();
  • Type: java.lang.String OR 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 java.lang.Object getAttrSubscriptionName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SubscriptionName: The name of the subscription.


attrSubscriptionUrlRequired

public java.lang.Object getAttrSubscriptionUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SubscriptionURL: TThe URL of the subscription.


attrTopicNameRequired

public java.lang.Object getAttrTopicName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TopicName: The name of the topic.


attrTopicOwnerRequired

public java.lang.Object getAttrTopicOwner();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TopicOwner: The owner of the topic.


propsRequired

public SubscriptionProps getProps();