Package software.amazon.awscdk.services.greengrass

Class CfnSubscriptionDefinitionVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.greengrass.CfnSubscriptionDefinitionVersion

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:39.044Z")
@Stability(Stable)
public class CfnSubscriptionDefinitionVersion
extends CfnResource
implements IInspectable

The AWS::Greengrass::SubscriptionDefinitionVersion resource represents a subscription definition version for AWS IoT Greengrass .

A subscription definition version contains a list of subscriptions.

To create a subscription definition version, you must specify the ID of the subscription definition that you want to associate with the version. For information about creating a subscription definition, see AWS::Greengrass::SubscriptionDefinition .

After you create a 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.*;
 CfnSubscriptionDefinitionVersion cfnSubscriptionDefinitionVersion = CfnSubscriptionDefinitionVersion.Builder.create(this, "MyCfnSubscriptionDefinitionVersion")
         .subscriptionDefinitionId("subscriptionDefinitionId")
         .subscriptions(List.of(SubscriptionProperty.builder()
                 .id("id")
                 .source("source")
                 .subject("subject")
                 .target("target")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSubscriptionDefinitionVersion.Builder	A fluent builder for CfnSubscriptionDefinitionVersion.
static interface	CfnSubscriptionDefinitionVersion.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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSubscriptionDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubscriptionDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSubscriptionDefinitionVersion(software.constructs.Construct scope, String id, CfnSubscriptionDefinitionVersionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getSubscriptionDefinitionId()	The ID of the subscription definition associated with this version.
Object	getSubscriptions()	The subscriptions in this version.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setSubscriptionDefinitionId(String value)	The ID of the subscription definition associated with this version.
void	setSubscriptions(List<Object> value)	The subscriptions in this version.
void	setSubscriptions(IResolvable value)	The subscriptions in this version.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 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

CfnSubscriptionDefinitionVersion

protected CfnSubscriptionDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)

CfnSubscriptionDefinitionVersion

protected CfnSubscriptionDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSubscriptionDefinitionVersion

@Stability(Stable)
public CfnSubscriptionDefinitionVersion(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSubscriptionDefinitionVersionProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSubscriptionDefinitionId

@Stability(Stable)
@NotNull
public String getSubscriptionDefinitionId()

The ID of the subscription definition associated with this version.

setSubscriptionDefinitionId

@Stability(Stable)
public void setSubscriptionDefinitionId(@NotNull
 String value)

The ID of the subscription definition associated with this version.

getSubscriptions

@Stability(Stable)
@NotNull
public Object getSubscriptions()

The subscriptions in this version.

setSubscriptions

@Stability(Stable)
public void setSubscriptions(@NotNull
 IResolvable value)

The subscriptions in this version.

setSubscriptions

@Stability(Stable)
public void setSubscriptions(@NotNull
 List<Object> value)

The subscriptions in this version.