software.amazon.awscdk.services.greengrass

Class CfnDeviceDefinitionVersion

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

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

A CloudFormation `AWS::Greengrass::DeviceDefinitionVersion`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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 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
	CfnDeviceDefinitionVersion(Construct scope, java.lang.String id, CfnDeviceDefinitionVersionProps props) Create a new `AWS::Greengrass::DeviceDefinitionVersion`.
protected	CfnDeviceDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeviceDefinitionVersion(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	getDeviceDefinitionId() The ID of the device definition associated with this version.
java.lang.Object	getDevices() The devices 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	setDeviceDefinitionId(java.lang.String value) The ID of the device definition associated with this version.
void	setDevices(IResolvable value) The devices in this version.
void	setDevices(java.util.List<java.lang.Object> value) The devices 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

CfnDeviceDefinitionVersion

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

CfnDeviceDefinitionVersion

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

CfnDeviceDefinitionVersion

public CfnDeviceDefinitionVersion(Construct scope,
                                  java.lang.String id,
                                  CfnDeviceDefinitionVersionProps props)

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

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

getDeviceDefinitionId

public java.lang.String getDeviceDefinitionId()

The ID of the device definition associated with this version.

This value is a GUID.

setDeviceDefinitionId

public void setDeviceDefinitionId(java.lang.String value)

The ID of the device definition associated with this version.

This value is a GUID.

getDevices

public java.lang.Object getDevices()

The devices in this version.

setDevices

public void setDevices(IResolvable value)

The devices in this version.

setDevices

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

The devices in this version.