Package software.amazon.awscdk.services.greengrass

Interface CfnDeviceDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeviceDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.962Z")
@Stability(Stable)
public interface CfnDeviceDefinitionProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.greengrass.*;
 Object tags;
 CfnDeviceDefinitionProps cfnDeviceDefinitionProps = CfnDeviceDefinitionProps.builder()
         .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	Interface	Description
static final class	CfnDeviceDefinitionProps.Builder	A builder for CfnDeviceDefinitionProps
static final class	CfnDeviceDefinitionProps.Jsii$Proxy	An implementation for CfnDeviceDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnDeviceDefinitionProps.Builder	builder()
default Object	getInitialVersion()	The device definition version to include when the device definition is created.
String	getName()	The name of the device definition.
default Object	getTags()	Application-specific metadata to attach to the device definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the device definition.

getInitialVersion

@Stability(Stable)
@Nullable
default 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.

getTags

@Stability(Stable)
@Nullable
default Object 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"
 }
 

builder

@Stability(Stable)
static CfnDeviceDefinitionProps.Builder builder()

Returns:

a CfnDeviceDefinitionProps.Builder of CfnDeviceDefinitionProps