Skip to content

Subscription

This class encapsulates and extends the ROS resource type DATASOURCE::MNS::Subscription, which is used to query the information about a subscription.

Initializers 

from ros_cdk_mns import datasource
datasource.Subscription(
  scope: Construct,
  id: str,
  subscription_name: typing.Union[str, IResolvable],
  topic_name: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
subscription_name typing.Union[str, ros_cdk_core.IResolvable] Property subscriptionName: The name of the subscription.
topic_name typing.Union[str, ros_cdk_core.IResolvable] Property topicName: The name of the topic.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

subscription_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property subscriptionName: The name of the subscription.

topic_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property topicName: The name of the topic.

refresh_optionsOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

from ros_cdk_mns import datasource
datasource.Subscription.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the subscription was created.
attr_endpoint ros_cdk_core.IResolvable Attribute Endpoint: The endpoint that is used by the subscriber to receive messages.
attr_filter_tag ros_cdk_core.IResolvable Attribute FilterTag: Describes the labels by which messages are filtered in this subscription (only messages with consistent labels are pushed).
attr_last_modify_time ros_cdk_core.IResolvable Attribute LastModifyTime: The time when the subscription was last modified.
attr_notify_content_format ros_cdk_core.IResolvable Attribute NotifyContentFormat: The format of the message that is pushed to the endpoint.
attr_notify_strategy 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.
attr_subscription_name ros_cdk_core.IResolvable Attribute SubscriptionName: The name of the subscription.
attr_subscription_url ros_cdk_core.IResolvable Attribute SubscriptionURL: TThe URL of the subscription.
attr_topic_name ros_cdk_core.IResolvable Attribute TopicName: The name of the topic.
attr_topic_owner ros_cdk_core.IResolvable Attribute TopicOwner: The owner of the topic.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the subscription was created.

attr_endpointRequired 

attr_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_filter_tagRequired 

attr_filter_tag: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_last_modify_timeRequired 

attr_last_modify_time: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_notify_content_formatRequired 

attr_notify_content_format: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_notify_strategyRequired 

attr_notify_strategy: IResolvable
  • Type: 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.

attr_subscription_nameRequired 

attr_subscription_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SubscriptionName: The name of the subscription.

attr_subscription_urlRequired 

attr_subscription_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SubscriptionURL: TThe URL of the subscription.

attr_topic_nameRequired 

attr_topic_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TopicName: The name of the topic.

attr_topic_ownerRequired 

attr_topic_owner: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TopicOwner: The owner of the topic.