Class CfnDeviceDefinition

The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDeviceDefinition

Implements

IInspectable

IDeviceDefinitionRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Greengrass

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeviceDefinition : CfnResource, IInspectable, IDeviceDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDeviceDefinition Inherits CfnResource Implements IInspectable, IDeviceDefinitionRef, IConstruct, IDependable, IEnvironmentAware, 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

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(Construct, string, ICfnDeviceDefinitionProps)

Create a new AWS::Greengrass::DeviceDefinition.

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 .
AttrId	The ID of the DeviceDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .
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 .
AttrName	The name of the device definition.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .
DeviceDefinitionRef	A reference to a DeviceDefinition resource.
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

ArnForDeviceDefinition(IDeviceDefinitionRef)	The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .
FromDeviceDefinitionArn(Construct, string, string)	Creates a new IDeviceDefinitionRef from an ARN.
FromDeviceDefinitionId(Construct, string, string)	Creates a new IDeviceDefinitionRef from a deviceDefinitionId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDeviceDefinition(object)	Checks whether the given object is a CfnDeviceDefinition.
RenderProperties(IDictionary<string, object>)	The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .

Constructors

CfnDeviceDefinition(Construct, string, ICfnDeviceDefinitionProps)

Create a new AWS::Greengrass::DeviceDefinition.

public CfnDeviceDefinition(Construct scope, string id, ICfnDeviceDefinitionProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDeviceDefinitionProps

Resource properties.

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

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

string

Remarks

CloudformationAttribute: Arn

AttrId

The ID of the DeviceDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

public virtual string AttrId { get; }

Property Value

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

string

Remarks

CloudformationAttribute: LatestVersionArn

AttrName

The name of the device definition.

public virtual string AttrName { get; }

Property Value

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

string

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

DeviceDefinitionRef

A reference to a DeviceDefinition resource.

public virtual IDeviceDefinitionReference DeviceDefinitionRef { get; }

Property Value

IDeviceDefinitionReference

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

InitialVersion

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

public virtual object? InitialVersion { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeviceDefinition.IDeviceDefinitionVersionProperty

Name

The name of the device definition.

public virtual string Name { get; set; }

Property Value

string

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

TagsRaw

Application-specific metadata to attach to the device definition.

public virtual object? TagsRaw { get; set; }

Property Value

object

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

Methods

ArnForDeviceDefinition(IDeviceDefinitionRef)

The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .

public static string ArnForDeviceDefinition(IDeviceDefinitionRef resource)

Parameters

resource IDeviceDefinitionRef

Returns

string

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

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
             });

FromDeviceDefinitionArn(Construct, string, string)

Creates a new IDeviceDefinitionRef from an ARN.

public static IDeviceDefinitionRef FromDeviceDefinitionArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IDeviceDefinitionRef

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

FromDeviceDefinitionId(Construct, string, string)

Creates a new IDeviceDefinitionRef from a deviceDefinitionId.

public static IDeviceDefinitionRef FromDeviceDefinitionId(Construct scope, string id, string deviceDefinitionId)

Parameters

scope Construct

id string

deviceDefinitionId string

Returns

IDeviceDefinitionRef

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

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.

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

IsCfnDeviceDefinition(object)

Checks whether the given object is a CfnDeviceDefinition.

public static bool IsCfnDeviceDefinition(object x)

Parameters

x object

Returns

bool

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html"><code>AWS::Greengrass::DeviceDefinitionVersion</code></a> 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 .

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

CloudformationResource: AWS::Greengrass::DeviceDefinition

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDeviceDefinitionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable