CfnGroupPropsMixin

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

Bases: Mixin

AWS IoT Greengrass seamlessly extends AWS to edge devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage.

With AWS IoT Greengrass , connected devices can run AWS Lambda functions, execute predictions based on machine learning models, keep device data in sync, and communicate with other devices securely – even when not connected to the internet. For more information, see the Developer Guide . .. epigraph:

For AWS Region support, see `CloudFormation Support for AWS IoT Greengrass <https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html>`_ in the *Developer Guide* .

The AWS::Greengrass::Group resource represents a group in AWS IoT Greengrass . In the AWS IoT Greengrass API, groups are used to organize your group versions.

Groups can reference multiple group versions. All group versions must be associated with a group. A group version references a device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device.

To deploy a group version, the group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. .. epigraph:

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

To change group components (such as devices, subscriptions, or functions), you must create new versions. This is because versions are immutable. For example, to add a function, you create a function definition version that contains the new function (and all other functions that you want to deploy). Then you create a group version that references the new function definition version (and all other version types that you want to deploy).

Deploying a Group Version

After you create the group version in your CloudFormation template, you can deploy it using the `aws greengrass create-deployment <https://docs.aws.amazon.com/greengrass/v1/apireference/createdeployment-post.html>`_ command in the AWS CLI or from the Greengrass node in the AWS IoT console. To deploy a group version, you must have a Greengrass service role associated with your AWS account . For more information, see CloudFormation Support for AWS IoT Greengrass in the Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource:

AWS::Greengrass::Group

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_group_props_mixin = greengrass_mixins.CfnGroupPropsMixin(greengrass_mixins.CfnGroupMixinProps(
    initial_version=greengrass_mixins.CfnGroupPropsMixin.GroupVersionProperty(
        connector_definition_version_arn="connectorDefinitionVersionArn",
        core_definition_version_arn="coreDefinitionVersionArn",
        device_definition_version_arn="deviceDefinitionVersionArn",
        function_definition_version_arn="functionDefinitionVersionArn",
        logger_definition_version_arn="loggerDefinitionVersionArn",
        resource_definition_version_arn="resourceDefinitionVersionArn",
        subscription_definition_version_arn="subscriptionDefinitionVersionArn"
    ),
    name="name",
    role_arn="roleArn",
    tags=tags
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnGroupMixinProps, 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', 'roleArn', '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

GroupVersionProperty

class CfnGroupPropsMixin.GroupVersionProperty(*, connector_definition_version_arn=None, core_definition_version_arn=None, device_definition_version_arn=None, function_definition_version_arn=None, logger_definition_version_arn=None, resource_definition_version_arn=None, subscription_definition_version_arn=None)

Bases: object

A group version in AWS IoT Greengrass , which references of a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device.

The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.

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

Parameters:

  • connector_definition_version_arn (Optional[str]) – The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.

  • core_definition_version_arn (Optional[str]) – The ARN of the core definition version that contains the core you want to deploy with the group version. Currently, the core definition version can contain only one core.

  • device_definition_version_arn (Optional[str]) – The ARN of the device definition version that contains the devices you want to deploy with the group version.

  • function_definition_version_arn (Optional[str]) – The ARN of the function definition version that contains the functions you want to deploy with the group version.

  • logger_definition_version_arn (Optional[str]) – The ARN of the logger definition version that contains the loggers you want to deploy with the group version.

  • resource_definition_version_arn (Optional[str]) – The ARN of the resource definition version that contains the resources you want to deploy with the group version.

  • subscription_definition_version_arn (Optional[str]) – The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.

See:

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

group_version_property = greengrass_mixins.CfnGroupPropsMixin.GroupVersionProperty(
    connector_definition_version_arn="connectorDefinitionVersionArn",
    core_definition_version_arn="coreDefinitionVersionArn",
    device_definition_version_arn="deviceDefinitionVersionArn",
    function_definition_version_arn="functionDefinitionVersionArn",
    logger_definition_version_arn="loggerDefinitionVersionArn",
    resource_definition_version_arn="resourceDefinitionVersionArn",
    subscription_definition_version_arn="subscriptionDefinitionVersionArn"
)

Attributes

connector_definition_version_arn

The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-connectordefinitionversionarn

core_definition_version_arn

The ARN of the core definition version that contains the core you want to deploy with the group version.

Currently, the core definition version can contain only one core.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-coredefinitionversionarn

device_definition_version_arn

The ARN of the device definition version that contains the devices you want to deploy with the group version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-devicedefinitionversionarn

function_definition_version_arn

The ARN of the function definition version that contains the functions you want to deploy with the group version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-functiondefinitionversionarn

logger_definition_version_arn

The ARN of the logger definition version that contains the loggers you want to deploy with the group version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-loggerdefinitionversionarn

resource_definition_version_arn

The ARN of the resource definition version that contains the resources you want to deploy with the group version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-resourcedefinitionversionarn

subscription_definition_version_arn

The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-group-groupversion.html#cfn-greengrass-group-groupversion-subscriptiondefinitionversionarn