CfnSubscriptionDefinition (software.amazon.awscdk:greengrass 1.182.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.core.Construct
    - - software.amazon.awscdk.core.CfnElement
      - software.amazon.awscdk.core.CfnRefElement
        
        software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.greengrass.CfnSubscriptionDefinition

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
```
@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.248Z")
 @Stability(value=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();
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnSubscriptionDefinition.Builder` A fluent builder for `CfnSubscriptionDefinition`.
`static interface`	`CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty` A subscription definition version contains a list of [subscriptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) .
`static interface`	`CfnSubscriptionDefinition.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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnSubscriptionDefinition(Construct scope, String id, CfnSubscriptionDefinitionProps props)` Create a new `AWS::Greengrass::SubscriptionDefinition`.
`protected`	`CfnSubscriptionDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnSubscriptionDefinition(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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` .
`String`	`getAttrId()` The ID of the `SubscriptionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
`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` .
`String`	`getAttrName()` The name of the `SubscriptionDefinition` , such as `MySubscriptionDefinition` .
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getInitialVersion()` The subscription definition version to include when the subscription definition is created.
`String`	`getName()` The name of the subscription definition.
`TagManager`	`getTags()` Application-specific metadata to attach to the subscription definition.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setInitialVersion(CfnSubscriptionDefinition.SubscriptionDefinitionVersionProperty value)` The subscription definition version to include when the subscription definition is created.
`void`	`setInitialVersion(IResolvable value)` The subscription definition version to include when the subscription definition is created.
`void`	`setName(String value)` The name of the subscription definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnSubscriptionDefinition
```
protected CfnSubscriptionDefinition(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnSubscriptionDefinition
```
protected CfnSubscriptionDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnSubscriptionDefinition
```
@Stability(value=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 Detail
  - inspect
```
@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()
```
    The ID of the `SubscriptionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
  - getAttrLatestVersionArn
```
@Stability(value=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(value=Stable)
 @NotNull
public String getAttrName()
```
    The name of the `SubscriptionDefinition` , such as `MySubscriptionDefinition` .
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=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(value=Stable)
 @NotNull
public String getName()
```
    The name of the subscription definition.
  - setName
```
@Stability(value=Stable)
public void setName(@NotNull
                                             String value)
```
    The name of the subscription definition.
  - getInitialVersion
```
@Stability(value=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(value=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(value=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.

Class CfnSubscriptionDefinition

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnSubscriptionDefinition

CfnSubscriptionDefinition

CfnSubscriptionDefinition

Method Detail

inspect

renderProperties

getAttrArn

getAttrId

getAttrLatestVersionArn

getAttrName

getCfnProperties

getTags

getName

setName

getInitialVersion

setInitialVersion

setInitialVersion