Show / Hide Table of Contents

Interface CfnDeviceDefinitionPropsMixin.IDeviceProperty

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

Namespace: Amazon.CDK.Mixins.Preview.AWS.Greengrass.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnDeviceDefinitionPropsMixin.IDeviceProperty
Syntax (vb)
Public Interface CfnDeviceDefinitionPropsMixin.IDeviceProperty
Remarks

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 CloudFormation template, the Devices property of the DeviceDefinitionVersion property type contains a list of Device property types.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Greengrass.Mixins;

             var deviceProperty = new DeviceProperty {
                 CertificateArn = "certificateArn",
                 Id = "id",
                 SyncShadow = false,
                 ThingArn = "thingArn"
             };

Synopsis

Properties

CertificateArn

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

Id

A descriptive or arbitrary ID for the device.

SyncShadow

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

ThingArn

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

Properties

CertificateArn

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

string? CertificateArn { get; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-certificatearn

Id

A descriptive or arbitrary ID for the device.

string? Id { get; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-id

SyncShadow

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

object? SyncShadow { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-syncshadow

Type union: either bool or IResolvable

ThingArn

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

string? ThingArn { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html#cfn-greengrass-devicedefinition-device-thingarn

Back to top Generated by DocFX