interface CfnDeviceDefinitionProps

Language	Type name
.NET	`Amazon.CDK.AWS.Greengrass.CfnDeviceDefinitionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgreengrass#CfnDeviceDefinitionProps`
Java	`software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps`
Python	`aws_cdk.aws_greengrass.CfnDeviceDefinitionProps`
TypeScript	`aws-cdk-lib` » `aws_greengrass` » `CfnDeviceDefinitionProps`

Properties for defining a CfnDeviceDefinition.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_greengrass as greengrass } from 'aws-cdk-lib';

declare const tags: any;
const cfnDeviceDefinitionProps: greengrass.CfnDeviceDefinitionProps = {
  name: 'name',

  // the properties below are optional
  initialVersion: {
    devices: [{
      certificateArn: 'certificateArn',
      id: 'id',
      thingArn: 'thingArn',

      // the properties below are optional
      syncShadow: false,
    }],
  },
  tags: tags,
};

Properties

Name	Type	Description
name	`string`	The name of the device definition.
initialVersion?	`IResolvable` `\|` `DeviceDefinitionVersionProperty`	The device definition version to include when the device definition is created.
tags?	`any`	Application-specific metadata to attach to the device definition.

name

Type: string

The name of the device definition.

initialVersion?

Type: IResolvable | DeviceDefinitionVersionProperty (optional)

The device definition version to include when the device definition is created.

A device definition version contains a list of device property types.

To associate a device definition version after the device definition is created, create an AWS::Greengrass::DeviceDefinitionVersion resource and specify the ID of this device definition.

tags?

Type: any (optional)

Application-specific metadata to attach to the device definition.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates.

"Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
}