interface SubscriptionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.Greengrass.Mixins.CfnSubscriptionDefinitionVersionPropsMixin.SubscriptionProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgreengrass/mixins#CfnSubscriptionDefinitionVersionPropsMixin_SubscriptionProperty |
 Java | software.amazon.awscdk.mixins.preview.services.greengrass.mixins.CfnSubscriptionDefinitionVersionPropsMixin.SubscriptionProperty |
 Python | aws_cdk.mixins_preview.aws_greengrass.mixins.CfnSubscriptionDefinitionVersionPropsMixin.SubscriptionProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_greengrass » mixins » CfnSubscriptionDefinitionVersionPropsMixin » SubscriptionProperty |
Subscriptions define how MQTT messages can be exchanged between devices, functions, and connectors in the group, and with AWS IoT or the local shadow service.
A subscription defines a message source, message target, and a topic (or subject) that's used to route messages from the source to the target. A subscription defines the message flow in one direction, from the source to the target. For two-way communication, you must set up two subscriptions, one for each direction.
In an CloudFormation template, the Subscriptions property of the AWS::Greengrass::SubscriptionDefinitionVersion resource contains a list of Subscription property types.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as greengrass_mixins } from '@aws-cdk/mixins-preview/aws-greengrass';
const subscriptionProperty: greengrass_mixins.CfnSubscriptionDefinitionVersionPropsMixin.SubscriptionProperty = {
id: 'id',
source: 'source',
subject: 'subject',
target: 'target',
};
Properties
| Name | Type | Description |
|---|---|---|
| id? | string | A descriptive or arbitrary ID for the subscription. |
| source? | string | The originator of the message. |
| subject? | string | The MQTT topic used to route the message. |
| target? | string | The destination of the message. |
id?
Type:
string
(optional)
A descriptive or arbitrary ID for the subscription.
This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .
source?
Type:
string
(optional)
The originator of the message.
The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, cloud (which represents the AWS IoT cloud), or GGShadowService .
subject?
Type:
string
(optional)
The MQTT topic used to route the message.
target?
Type:
string
(optional)
The destination of the message.
The value can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, cloud (which represents the AWS IoT cloud), or GGShadowService .