CfnDeviceDefinitionPropsMixin

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

Bases: Mixin

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. .. epigraph:

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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html>`_ 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`` <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-devicedefinition.html
CloudformationResource:: AWS::Greengrass::DeviceDefinition
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

# tags: Any

cfn_device_definition_props_mixin = greengrass_mixins.CfnDeviceDefinitionPropsMixin(greengrass_mixins.CfnDeviceDefinitionMixinProps(
    initial_version=greengrass_mixins.CfnDeviceDefinitionPropsMixin.DeviceDefinitionVersionProperty(
        devices=[greengrass_mixins.CfnDeviceDefinitionPropsMixin.DeviceProperty(
            certificate_arn="certificateArn",
            id="id",
            sync_shadow=False,
            thing_arn="thingArn"
        )]
    ),
    name="name",
    tags=tags
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnDeviceDefinitionMixinProps, 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 = ['initialVersion', 'name', 'tags']

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

DeviceDefinitionVersionProperty

class CfnDeviceDefinitionPropsMixin.DeviceDefinitionVersionProperty(*, devices=None)

Bases: object

A device definition version contains a list of devices .

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

In an CloudFormation template, DeviceDefinitionVersion is the property type of the InitialVersion property in the `AWS::Greengrass::DeviceDefinition <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html>`_ resource.

Parameters:: devices (Union[IResolvable, Sequence[Union[IResolvable, DeviceProperty, Dict[str, Any]]], None]) – The devices in this version.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.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_definition_version_property = greengrass_mixins.CfnDeviceDefinitionPropsMixin.DeviceDefinitionVersionProperty(
    devices=[greengrass_mixins.CfnDeviceDefinitionPropsMixin.DeviceProperty(
        certificate_arn="certificateArn",
        id="id",
        sync_shadow=False,
        thing_arn="thingArn"
    )]
)

Attributes

devices

The devices in this version.

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

DeviceProperty

class CfnDeviceDefinitionPropsMixin.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 `DeviceDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-devicedefinitionversion.html>`_ property type contains a list of Device property types.

Parameters:

certificate_arn (Optional[str]) – The Amazon Resource Name (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 ARN of the device, which is an AWS IoT device (thing).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-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.CfnDeviceDefinitionPropsMixin.DeviceProperty(
    certificate_arn="certificateArn",
    id="id",
    sync_shadow=False,
    thing_arn="thingArn"
)