Package software.amazon.awscdk.services.greengrass

Class CfnDeviceDefinitionVersion

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:17.839Z")
@Stability(Stable)
public class CfnDeviceDefinitionVersion
extends CfnResource
implements IInspectable

The AWS::Greengrass::DeviceDefinitionVersion resource represents a device definition version for AWS IoT Greengrass .

A device definition version contains a list of devices.

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

After you create a device definition version that contains the devices 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.*;
 CfnDeviceDefinitionVersion cfnDeviceDefinitionVersion = CfnDeviceDefinitionVersion.Builder.create(this, "MyCfnDeviceDefinitionVersion")
         .deviceDefinitionId("deviceDefinitionId")
         .devices(List.of(DeviceProperty.builder()
                 .certificateArn("certificateArn")
                 .id("id")
                 .thingArn("thingArn")
                 // the properties below are optional
                 .syncShadow(false)
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDeviceDefinitionVersion.Builder	A fluent builder for CfnDeviceDefinitionVersion.
static interface	CfnDeviceDefinitionVersion.DeviceProperty	A device is an AWS IoT device (thing) that's added to a Greengrass group.

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	CfnDeviceDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeviceDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDeviceDefinitionVersion(software.constructs.Construct scope, String id, CfnDeviceDefinitionVersionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getDeviceDefinitionId()	The ID of the device definition associated with this version.
Object	getDevices()	The devices in this version.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeviceDefinitionId(String value)	The ID of the device definition associated with this version.
void	setDevices(List<Object> value)	The devices in this version.
void	setDevices(IResolvable value)	The devices 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

CfnDeviceDefinitionVersion

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

CfnDeviceDefinitionVersion

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

CfnDeviceDefinitionVersion

@Stability(Stable)
public CfnDeviceDefinitionVersion(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDeviceDefinitionVersionProps 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

getDeviceDefinitionId

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

The ID of the device definition associated with this version.

setDeviceDefinitionId

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

The ID of the device definition associated with this version.

getDevices

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

The devices in this version.

setDevices

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

The devices in this version.

setDevices

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

The devices in this version.