software.amazon.awscdk.services.greengrass

Class CfnDeviceDefinition

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.greengrass.CfnDeviceDefinition

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.334Z")
public class CfnDeviceDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::DeviceDefinition`.

The AWS::Greengrass::DeviceDefinition resource represents a device definition for AWS IoT Greengrass . 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 .

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.*;
 Object tags;
 CfnDeviceDefinition cfnDeviceDefinition = CfnDeviceDefinition.Builder.create(this, "MyCfnDeviceDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(DeviceDefinitionVersionProperty.builder()
                 .devices(List.of(DeviceProperty.builder()
                         .certificateArn("certificateArn")
                         .id("id")
                         .thingArn("thingArn")
                         // the properties below are optional
                         .syncShadow(false)
                         .build()))
                 .build())
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDeviceDefinition.Builder A fluent builder for CfnDeviceDefinition.
static interface	CfnDeviceDefinition.DeviceDefinitionVersionProperty A device definition version contains a list of [devices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) .
static interface	CfnDeviceDefinition.DeviceProperty A device is an AWS IoT device (thing) that's added to a Greengrass group.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDeviceDefinition(Construct scope, java.lang.String id, CfnDeviceDefinitionProps props) Create a new `AWS::Greengrass::DeviceDefinition`.
protected	CfnDeviceDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeviceDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the `DeviceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
java.lang.String	getAttrId() The ID of the `DeviceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
java.lang.String	getAttrLatestVersionArn() 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` .
java.lang.String	getAttrName() The name of the device definition.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getInitialVersion() The device definition version to include when the device definition is created.
java.lang.String	getName() The name of the device definition.
TagManager	getTags() Application-specific metadata to attach to the device definition.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setInitialVersion(CfnDeviceDefinition.DeviceDefinitionVersionProperty value) The device definition version to include when the device definition is created.
void	setInitialVersion(IResolvable value) The device definition version to include when the device definition is created.
void	setName(java.lang.String value) The name of the device definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDeviceDefinition

protected CfnDeviceDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeviceDefinition

protected CfnDeviceDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeviceDefinition

public CfnDeviceDefinition(Construct scope,
                           java.lang.String id,
                           CfnDeviceDefinitionProps props)

Create a new `AWS::Greengrass::DeviceDefinition`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the `DeviceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/devices/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .

getAttrId

public java.lang.String getAttrId()

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

getAttrLatestVersionArn

public java.lang.String getAttrLatestVersionArn()

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` .

getAttrName

public java.lang.String getAttrName()

The name of the device definition.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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"
 }
 

getName

public java.lang.String getName()

The name of the device definition.

setName

public void setName(java.lang.String value)

The name of the device definition.

getInitialVersion

public java.lang.Object getInitialVersion()

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.

setInitialVersion

public void setInitialVersion(IResolvable value)

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.

setInitialVersion

public void setInitialVersion(CfnDeviceDefinition.DeviceDefinitionVersionProperty value)

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.