Class CfnSubscriptionDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.065Z") @Stability(Stable) public class CfnSubscriptionDefinition extends CfnResource implements IInspectable
A CloudFormation AWS::Greengrass::SubscriptionDefinition.

The AWS::Greengrass::SubscriptionDefinition resource represents a subscription definition for AWS IoT Greengrass . Subscription definitions are used to organize your subscription definition versions.

Subscription definitions can reference multiple subscription definition versions. All subscription definition versions must be associated with a subscription definition. Each subscription definition version can contain one or more subscriptions.

When you create a subscription definition, you can optionally include an initial subscription definition version. To associate a subscription definition version later, create an AWS::Greengrass::SubscriptionDefinitionVersion resource and specify the ID of this subscription definition.

After you create the subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see AWS::Greengrass::Group .

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.*;
 Object tags;
 CfnSubscriptionDefinition cfnSubscriptionDefinition = CfnSubscriptionDefinition.Builder.create(this, "MyCfnSubscriptionDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(SubscriptionDefinitionVersionProperty.builder()
                 .subscriptions(List.of(SubscriptionProperty.builder()
                         .id("id")
                         .source("source")
                         .subject("subject")
                         .target("target")
                         .build()))
                 .build())
         .tags(tags)
         .build();
 
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnSubscriptionDefinition

      protected CfnSubscriptionDefinition(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnSubscriptionDefinition

      protected CfnSubscriptionDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnSubscriptionDefinition

      @Stability(Stable) public CfnSubscriptionDefinition(@NotNull Construct scope, @NotNull String id, @NotNull CfnSubscriptionDefinitionProps props)
      Create a new AWS::Greengrass::SubscriptionDefinition.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the SubscriptionDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .
    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the SubscriptionDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .
    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public String getAttrLatestVersionArn()
      The ARN of the last SubscriptionDefinitionVersion that was added to the SubscriptionDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2 .
    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the SubscriptionDefinition , such as MySubscriptionDefinition .
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Application-specific metadata to attach to the subscription definition.

      You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

      This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates.

       "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
       }
       
    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the subscription definition.
    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the subscription definition.
    • getInitialVersion

      @Stability(Stable) @Nullable public Object getInitialVersion()
      The subscription definition version to include when the subscription definition is created.

      A subscription definition version contains a list of subscription property types.

      To associate a subscription definition version after the subscription definition is created, create an AWS::Greengrass::SubscriptionDefinitionVersion resource and specify the ID of this subscription definition.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable IResolvable value)
      The subscription definition version to include when the subscription definition is created.

      A subscription definition version contains a list of subscription property types.

      To associate a subscription definition version after the subscription definition is created, create an AWS::Greengrass::SubscriptionDefinitionVersion resource and specify the ID of this subscription definition.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty value)
      The subscription definition version to include when the subscription definition is created.

      A subscription definition version contains a list of subscription property types.

      To associate a subscription definition version after the subscription definition is created, create an AWS::Greengrass::SubscriptionDefinitionVersion resource and specify the ID of this subscription definition.