Interface CfnSubscriptionDefinition.SubscriptionProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSubscriptionDefinition.SubscriptionProperty.Jsii$Proxy
Enclosing class:
CfnSubscriptionDefinition

@Stability(Stable) public static interface CfnSubscriptionDefinition.SubscriptionProperty extends software.amazon.jsii.JsiiSerializable
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 AWS CloudFormation template, the Subscriptions property of the SubscriptionDefinitionVersion property type 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 software.amazon.awscdk.services.greengrass.*;
 SubscriptionProperty subscriptionProperty = SubscriptionProperty.builder()
         .id("id")
         .source("source")
         .subject("subject")
         .target("target")
         .build();
 
  • Method Details

    • getId

      @Stability(Stable) @NotNull String getId()
      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:_-]+ .

    • getSource

      @Stability(Stable) @NotNull String getSource()
      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 .

    • getSubject

      @Stability(Stable) @NotNull String getSubject()
      The MQTT topic used to route the message.
    • getTarget

      @Stability(Stable) @NotNull String getTarget()
      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 .

    • builder

      @Stability(Stable) static CfnSubscriptionDefinition.SubscriptionProperty.Builder builder()
      Returns:
      a CfnSubscriptionDefinition.SubscriptionProperty.Builder of CfnSubscriptionDefinition.SubscriptionProperty