software.amazon.awscdk.services.greengrass

Interface CfnDeviceDefinition.DeviceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeviceDefinition.DeviceProperty.Jsii$Proxy

Enclosing class:

CfnDeviceDefinition

@Stability(value=Stable)
public static interface CfnDeviceDefinition.DeviceProperty
extends software.amazon.jsii.JsiiSerializable

A device is an AWS IoT device (thing) that's added to a Greengrass group.

Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass ? in the Developer Guide .

In an AWS CloudFormation template, the Devices property of the DeviceDefinitionVersion property type contains a list of Device property types.

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.*;
 DeviceProperty deviceProperty = DeviceProperty.builder()
         .certificateArn("certificateArn")
         .id("id")
         .thingArn("thingArn")
         // the properties below are optional
         .syncShadow(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeviceDefinition.DeviceProperty.Builder A builder for CfnDeviceDefinition.DeviceProperty
static class	CfnDeviceDefinition.DeviceProperty.Jsii$Proxy An implementation for CfnDeviceDefinition.DeviceProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeviceDefinition.DeviceProperty.Builder	builder()
String	getCertificateArn() The Amazon Resource Name (ARN) of the device certificate for the device.
String	getId() A descriptive or arbitrary ID for the device.
default Object	getSyncShadow() Indicates whether the device's local shadow is synced with the cloud automatically.
String	getThingArn() The ARN of the device, which is an AWS IoT device (thing).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificateArn

@Stability(value=Stable)
 @NotNull
String getCertificateArn()

The Amazon Resource Name (ARN) of the device certificate for the device.

This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.

getId

@Stability(value=Stable)
 @NotNull
String getId()

A descriptive or arbitrary ID for the device.

This value must be unique within the device definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

getThingArn

@Stability(value=Stable)
 @NotNull
String getThingArn()

The ARN of the device, which is an AWS IoT device (thing).

getSyncShadow

@Stability(value=Stable)
 @Nullable
default Object getSyncShadow()

Indicates whether the device's local shadow is synced with the cloud automatically.

builder

@Stability(value=Stable)
static CfnDeviceDefinition.DeviceProperty.Builder builder()

Returns:

a CfnDeviceDefinition.DeviceProperty.Builder of CfnDeviceDefinition.DeviceProperty