CfnCoreDefinitionVersionPropsMixin

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

Bases: Mixin

The AWS::Greengrass::CoreDefinitionVersion resource represents a core definition version for AWS IoT Greengrass .

A core definition version contains a Greengrass core. .. epigraph:

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

After you create a core definition version that contains the core 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-coredefinitionversion.html
CloudformationResource:: AWS::Greengrass::CoreDefinitionVersion
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_core_definition_version_props_mixin = greengrass_mixins.CfnCoreDefinitionVersionPropsMixin(greengrass_mixins.CfnCoreDefinitionVersionMixinProps(
    core_definition_id="coreDefinitionId",
    cores=[greengrass_mixins.CfnCoreDefinitionVersionPropsMixin.CoreProperty(
        certificate_arn="certificateArn",
        id="id",
        sync_shadow=False,
        thing_arn="thingArn"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnCoreDefinitionVersionMixinProps, 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 = ['coreDefinitionId', 'cores']

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

CoreProperty

class CfnCoreDefinitionVersionPropsMixin.CoreProperty(*, certificate_arn=None, id=None, sync_shadow=None, thing_arn=None)

Bases: object

A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group.

For more information, see What Is AWS IoT Greengrass ? in the Developer Guide .

In an CloudFormation template, the Cores property of the `AWS::Greengrass::CoreDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html>`_ resource contains a list of Core property types. Currently, the list can contain only one core.

Parameters:

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinitionversion-core.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

core_property = greengrass_mixins.CfnCoreDefinitionVersionPropsMixin.CoreProperty(
    certificate_arn="certificateArn",
    id="id",
    sync_shadow=False,
    thing_arn="thingArn"
)