Package software.amazon.awscdk.services.greengrass

Class CfnDeviceDefinition

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.CfnDeviceDefinition
All Implemented Interfaces:
IInspectable, IDeviceDefinitionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.605Z") @Stability(Stable) public class CfnDeviceDefinition extends CfnResource implements IInspectable, IDeviceDefinitionRef, ITaggable
The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .

Device definitions are used to organize your device definition versions.

Device definitions can reference multiple device definition versions. All device definition versions must be associated with a device definition. Each device definition version can contain one or more devices.

When you create a device definition, you can optionally include an initial device definition version. To associate a device definition version later, create an AWS::Greengrass::DeviceDefinitionVersion resource and specify the ID of this device definition.

After you create the 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.*;
 Object tags;
 CfnDeviceDefinition cfnDeviceDefinition = CfnDeviceDefinition.Builder.create(this, "MyCfnDeviceDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(DeviceDefinitionVersionProperty.builder()
                 .devices(List.of(DeviceProperty.builder()
                         .certificateArn("certificateArn")
                         .id("id")
                         .thingArn("thingArn")
                         // the properties below are optional
                         .syncShadow(false)
                         .build()))
                 .build())
         .tags(tags)
         .build();

See Also:

  • 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

    • CfnDeviceDefinition

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

    • CfnDeviceDefinition

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

    • CfnDeviceDefinition

      @Stability(Stable) public CfnDeviceDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeviceDefinitionProps props)
      Create a new AWS::Greengrass::DeviceDefinition.

      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

    • arnForDeviceDefinition

      @Stability(Stable) @NotNull public static String arnForDeviceDefinition(@NotNull IDeviceDefinitionRef resource)
      Parameters:
      resource - This parameter is required.

    • fromDeviceDefinitionArn

      @Stability(Stable) @NotNull public static IDeviceDefinitionRef fromDeviceDefinitionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDeviceDefinitionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromDeviceDefinitionId

      @Stability(Stable) @NotNull public static IDeviceDefinitionRef fromDeviceDefinitionId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String deviceDefinitionId)
      Creates a new IDeviceDefinitionRef from a deviceDefinitionId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      deviceDefinitionId - This parameter is required.

    • isCfnDeviceDefinition

      @Stability(Stable) @NotNull public static Boolean isCfnDeviceDefinition(@NotNull Object x)
      Checks whether the given object is a CfnDeviceDefinition.

      Parameters:
      x - This parameter is required.

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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the DeviceDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the DeviceDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public String getAttrLatestVersionArn()
      The ARN of the last DeviceDefinitionVersion that was added to the DeviceDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2 .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the device definition.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDeviceDefinitionRef

      @Stability(Stable) @NotNull public DeviceDefinitionReference getDeviceDefinitionRef()
      A reference to a DeviceDefinition resource.
      Specified by:
      getDeviceDefinitionRef in interface IDeviceDefinitionRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the device definition.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the device definition.

    • getInitialVersion

      @Stability(Stable) @Nullable public Object getInitialVersion()
      The device definition version to include when the device definition is created.

      Returns union: either IResolvable or CfnDeviceDefinition.DeviceDefinitionVersionProperty

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable IResolvable value)
      The device definition version to include when the device definition is created.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable CfnDeviceDefinition.DeviceDefinitionVersionProperty value)
      The device definition version to include when the device definition is created.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      Application-specific metadata to attach to the device definition.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      Application-specific metadata to attach to the device definition.