CfnSubscriptionDefinition

java.lang.Object
- 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:

IConstruct, IDependable, IInspectable
```
@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:15.119Z")
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 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 java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnSubscriptionDefinition(Construct scope, java.lang.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
`java.lang.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` .
`java.lang.String`	`getAttrId()` The ID of the `SubscriptionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
`java.lang.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` .
`java.lang.String`	`getAttrName()` The name of the `SubscriptionDefinition` , such as `MySubscriptionDefinition` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getInitialVersion()` The subscription definition version to include when the subscription definition is created.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnSubscriptionDefinition(Construct scope,
                                 java.lang.String id,
                                 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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.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
```
public java.lang.String getAttrId()
```
    The ID of the `SubscriptionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
  - getAttrLatestVersionArn
```
public java.lang.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
```
public java.lang.String getAttrName()
```
    The name of the `SubscriptionDefinition` , such as `MySubscriptionDefinition` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
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
```
public java.lang.String getName()
```
    The name of the subscription definition.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the subscription definition.
  - getInitialVersion
```
public java.lang.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
```
public void setInitialVersion(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
```
public void setInitialVersion(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 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 java.lang.Object

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