software.amazon.awscdk.services.greengrass

Class CfnSubscriptionDefinitionVersion

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.437Z")
public class CfnSubscriptionDefinitionVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::SubscriptionDefinitionVersion`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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 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.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSubscriptionDefinitionVersion(Construct scope, java.lang.String id, CfnSubscriptionDefinitionVersionProps props) Create a new `AWS::Greengrass::SubscriptionDefinitionVersion`.
protected	CfnSubscriptionDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubscriptionDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getSubscriptionDefinitionId() The ID of the subscription definition associated with this version.
java.lang.Object	getSubscriptions() The subscriptions in this version.
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	setSubscriptionDefinitionId(java.lang.String value) The ID of the subscription definition associated with this version.
void	setSubscriptions(IResolvable value) The subscriptions in this version.
void	setSubscriptions(java.util.List<java.lang.Object> value) The subscriptions in this version.

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

CfnSubscriptionDefinitionVersion

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

CfnSubscriptionDefinitionVersion

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

CfnSubscriptionDefinitionVersion

public CfnSubscriptionDefinitionVersion(Construct scope,
                                        java.lang.String id,
                                        CfnSubscriptionDefinitionVersionProps props)

Create a new `AWS::Greengrass::SubscriptionDefinitionVersion`.

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.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSubscriptionDefinitionId

public java.lang.String getSubscriptionDefinitionId()

The ID of the subscription definition associated with this version.

This value is a GUID.

setSubscriptionDefinitionId

public void setSubscriptionDefinitionId(java.lang.String value)

The ID of the subscription definition associated with this version.

This value is a GUID.

getSubscriptions

public java.lang.Object getSubscriptions()

The subscriptions in this version.

setSubscriptions

public void setSubscriptions(IResolvable value)

The subscriptions in this version.

setSubscriptions

public void setSubscriptions(java.util.List<java.lang.Object> value)

The subscriptions in this version.