Package software.amazon.awscdk.services.greengrass

Class CfnDeviceDefinitionVersion

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.963Z") @Stability(Stable) 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();

  • 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 Construct scope, @NotNull String id, @NotNull 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 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.

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

      This value is a GUID.

    • setDeviceDefinitionId

      @Stability(Stable) public void setDeviceDefinitionId(@NotNull String value)
      The ID of the device definition associated with this version.

      This value is a GUID.

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