CfnCoreDefinitionPropsMixin

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

Bases: Mixin

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

Core definitions are used to organize your core definition versions.

Core definitions can reference multiple core definition versions. All core definition versions must be associated with a core definition. Each core definition version can contain one Greengrass core. .. epigraph:

When you create a core definition, you can optionally include an initial core definition version. To associate a core definition version later, create an ```AWS::Greengrass::CoreDefinitionVersion`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html>`_ resource and specify the ID of this core definition.

After you create the 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-coredefinition.html
CloudformationResource:: AWS::Greengrass::CoreDefinition
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_core_definition_props_mixin = greengrass_mixins.CfnCoreDefinitionPropsMixin(greengrass_mixins.CfnCoreDefinitionMixinProps(
    initial_version=greengrass_mixins.CfnCoreDefinitionPropsMixin.CoreDefinitionVersionProperty(
        cores=[greengrass_mixins.CfnCoreDefinitionPropsMixin.CoreProperty(
            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::CoreDefinition.

Parameters:

props (Union[CfnCoreDefinitionMixinProps, 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

CoreDefinitionVersionProperty

class CfnCoreDefinitionPropsMixin.CoreDefinitionVersionProperty(*, cores=None)

Bases: object

A core definition version contains a Greengrass core .

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

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

Parameters:: cores (Union[IResolvable, Sequence[Union[IResolvable, CoreProperty, Dict[str, Any]]], None]) – The Greengrass core in this version. Currently, the Cores property for a core definition version can contain only one core.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.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_definition_version_property = greengrass_mixins.CfnCoreDefinitionPropsMixin.CoreDefinitionVersionProperty(
    cores=[greengrass_mixins.CfnCoreDefinitionPropsMixin.CoreProperty(
        certificate_arn="certificateArn",
        id="id",
        sync_shadow=False,
        thing_arn="thingArn"
    )]
)

Attributes

cores

The Greengrass core in this version.

Currently, the Cores property for a core definition version can contain only one core.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html#cfn-greengrass-coredefinition-coredefinitionversion-cores

CoreProperty

class CfnCoreDefinitionPropsMixin.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 `CoreDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-coredefinitionversion.html>`_ property type contains a list of Core property types. Currently, the list can contain only one core.

Parameters:

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

See:

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