Class CfnDeviceDefinition
The AWS::Greengrass::DeviceDefinition
resource represents a device definition for AWS IoT Greengrass .
Inherited Members
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeviceDefinition : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDeviceDefinition
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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
.
CloudformationResource: AWS::Greengrass::DeviceDefinition
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.AWS.Greengrass;
var tags;
var cfnDeviceDefinition = new CfnDeviceDefinition(this, "MyCfnDeviceDefinition", new CfnDeviceDefinitionProps {
Name = "name",
// the properties below are optional
InitialVersion = new DeviceDefinitionVersionProperty {
Devices = new [] { new DeviceProperty {
CertificateArn = "certificateArn",
Id = "id",
ThingArn = "thingArn",
// the properties below are optional
SyncShadow = false
} }
},
Tags = tags
});
Synopsis
Constructors
CfnDeviceDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeviceDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDeviceDefinition(Construct, String, ICfnDeviceDefinitionProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the |
AttrId | The ID of the |
AttrLatestVersionArn | The ARN of the last |
AttrName | The name of the device definition. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
InitialVersion | The device definition version to include when the device definition is created. |
Name | The name of the device definition. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Application-specific metadata to attach to the device definition. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeviceDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeviceDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeviceDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeviceDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDeviceDefinition(Construct, String, ICfnDeviceDefinitionProps)
public CfnDeviceDefinition(Construct scope, string id, ICfnDeviceDefinitionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeviceDefinitionProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the DeviceDefinition
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The ID of the DeviceDefinition
, such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrLatestVersionArn
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
.
public virtual string AttrLatestVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LatestVersionArn
AttrName
The name of the device definition.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
InitialVersion
The device definition version to include when the device definition is created.
public virtual object InitialVersion { get; set; }
Property Value
System.Object
Name
The name of the device definition.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Application-specific metadata to attach to the device definition.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>