Skip to content

Topic

  • Implements: @alicloud/ros-cdk-mns.datasource.ITopic

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

Initializers

import { datasource } from '@alicloud/ros-cdk-mns'
new datasource.Topic(scope: Construct, id: string, props: TopicProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props TopicProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { datasource } from '@alicloud/ros-cdk-mns'
datasource.Topic.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • 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 topic was created.
attrLastModifyTime string | @alicloud/ros-cdk-core.IResolvable Attribute LastModifyTime: The time when the topic was last modified.
attrLoggingEnabled string | @alicloud/ros-cdk-core.IResolvable Attribute LoggingEnabled: Indicates whether the log management feature is enabled for the topic.
attrMaxMessageSize string | @alicloud/ros-cdk-core.IResolvable Attribute MaxMessageSize: The maximum size of a message body that is sent to the topic.
attrMessageCount string | @alicloud/ros-cdk-core.IResolvable Attribute MessageCount: The number of messages in the topic.
attrMessageRetentionPeriod string | @alicloud/ros-cdk-core.IResolvable Attribute MessageRetentionPeriod: The retention period of the message in the topic.
attrTopicInnerUrl string | @alicloud/ros-cdk-core.IResolvable Attribute TopicInnerUrl: The internal URL of the topic.
attrTopicName string | @alicloud/ros-cdk-core.IResolvable Attribute TopicName: The name of the MNS topic.
attrTopicUrl string | @alicloud/ros-cdk-core.IResolvable Attribute TopicUrl: The URL of the topic.
props TopicProps 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 topic was created.


attrLastModifyTimeRequired

public readonly attrLastModifyTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrLoggingEnabledRequired

public readonly attrLoggingEnabled: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute LoggingEnabled: Indicates whether the log management feature is enabled for the topic.


attrMaxMessageSizeRequired

public readonly attrMaxMessageSize: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MaxMessageSize: The maximum size of a message body that is sent to the topic.


attrMessageCountRequired

public readonly attrMessageCount: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MessageCount: The number of messages in the topic.


attrMessageRetentionPeriodRequired

public readonly attrMessageRetentionPeriod: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MessageRetentionPeriod: The retention period of the message in the topic.


attrTopicInnerUrlRequired

public readonly attrTopicInnerUrl: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TopicInnerUrl: The internal URL of the topic.


attrTopicNameRequired

public readonly attrTopicName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TopicName: The name of the MNS topic.


attrTopicUrlRequired

public readonly attrTopicUrl: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TopicUrl: The URL of the topic.


propsRequired

public readonly props: TopicProps;