Subscription
- Implements: @alicloud/ros-cdk-mns.datasource.ISubscription
This class encapsulates and extends the ROS resource type DATASOURCE::MNS::Subscription.
Initializers
import { datasource } from '@alicloud/ros-cdk-mns'
new datasource.Subscription(scope: Construct, id: string, props: SubscriptionProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | SubscriptionProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: SubscriptionProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-mns'
datasource.Subscription.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time when the subscription was created. |
attrEndpoint | string | @alicloud/ros-cdk-core.IResolvable | Attribute Endpoint: The endpoint that is used by the subscriber to receive messages. |
attrFilterTag | string | @alicloud/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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute LastModifyTime: The time when the subscription was last modified. |
attrNotifyContentFormat | string | @alicloud/ros-cdk-core.IResolvable | Attribute NotifyContentFormat: The format of the message that is pushed to the endpoint. |
attrNotifyStrategy | string | @alicloud/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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute SubscriptionName: The name of the subscription. |
attrSubscriptionUrl | string | @alicloud/ros-cdk-core.IResolvable | Attribute SubscriptionURL: TThe URL of the subscription. |
attrTopicName | string | @alicloud/ros-cdk-core.IResolvable | Attribute TopicName: The name of the topic. |
attrTopicOwner | string | @alicloud/ros-cdk-core.IResolvable | Attribute TopicOwner: The owner of the topic. |
props | SubscriptionProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The time when the subscription was created.
attrEndpointRequired
public readonly attrEndpoint: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Endpoint: The endpoint that is used by the subscriber to receive messages.
attrFilterTagRequired
public readonly attrFilterTag: string | IResolvable;
- Type: string | @alicloud/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 readonly attrLastModifyTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LastModifyTime: The time when the subscription was last modified.
attrNotifyContentFormatRequired
public readonly attrNotifyContentFormat: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute NotifyContentFormat: The format of the message that is pushed to the endpoint.
attrNotifyStrategyRequired
public readonly attrNotifyStrategy: string | IResolvable;
- Type: string | @alicloud/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 readonly attrSubscriptionName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SubscriptionName: The name of the subscription.
attrSubscriptionUrlRequired
public readonly attrSubscriptionUrl: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SubscriptionURL: TThe URL of the subscription.
attrTopicNameRequired
public readonly attrTopicName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TopicName: The name of the topic.
attrTopicOwnerRequired
public readonly attrTopicOwner: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TopicOwner: The owner of the topic.
propsRequired
public readonly props: SubscriptionProps;
- Type: SubscriptionProps