CfnDeviceDefinitionVersionPropsMixin

class aws_cdk.mixins_preview.aws_greengrass.mixins.CfnDeviceDefinitionVersionPropsMixin(props, *, strategy=None)

Bases: Mixin

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

A device definition version contains a list of devices. .. epigraph:

To create a device definition version, you must specify the ID of the device definition that you want to associate with the version. For information about creating a device definition, see ```AWS::Greengrass::DeviceDefinition`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html>`_ .

After you create a 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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html>`_ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html
CloudformationResource:: AWS::Greengrass::DeviceDefinitionVersion
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

cfn_device_definition_version_props_mixin = greengrass_mixins.CfnDeviceDefinitionVersionPropsMixin(greengrass_mixins.CfnDeviceDefinitionVersionMixinProps(
    device_definition_id="deviceDefinitionId",
    devices=[greengrass_mixins.CfnDeviceDefinitionVersionPropsMixin.DeviceProperty(
        certificate_arn="certificateArn",
        id="id",
        sync_shadow=False,
        thing_arn="thingArn"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Greengrass::DeviceDefinitionVersion.

Parameters:

props (Union[CfnDeviceDefinitionVersionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['deviceDefinitionId', 'devices']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DeviceProperty

class CfnDeviceDefinitionVersionPropsMixin.DeviceProperty(*, certificate_arn=None, id=None, sync_shadow=None, thing_arn=None)

Bases: object

A device is an AWS IoT device (thing) that’s added to a Greengrass group.

Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass ? in the Developer Guide .

In an CloudFormation template, the Devices property of the `AWS::Greengrass::DeviceDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html>`_ resource contains a list of Device property types.

Parameters:

certificate_arn (Optional[str]) – The ARN of the device certificate for the device. This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.
id (Optional[str]) – A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .
sync_shadow (Union[bool, IResolvable, None]) – Indicates whether the device’s local shadow is synced with the cloud automatically.
thing_arn (Optional[str]) – The Amazon Resource Name (ARN) of the device, which is an AWS IoT device (thing).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

device_property = greengrass_mixins.CfnDeviceDefinitionVersionPropsMixin.DeviceProperty(
    certificate_arn="certificateArn",
    id="id",
    sync_shadow=False,
    thing_arn="thingArn"
)

Attributes

certificate_arn

The ARN of the device certificate for the device.

This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-certificatearn

id

A descriptive or arbitrary ID for the device.

This value must be unique within the device definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-id

sync_shadow

Indicates whether the device’s local shadow is synced with the cloud automatically.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-syncshadow

thing_arn

The Amazon Resource Name (ARN) of the device, which is an AWS IoT device (thing).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinitionversion-device.html#cfn-greengrass-devicedefinitionversion-device-thingarn