Package software.amazon.awscdk.cfnpropertymixins.services.greengrass

Class CfnGroupPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.greengrass.CfnGroupPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:59.832Z") @Stability(Stable) public class CfnGroupPropsMixin extends Mixin implements software.constructs.IMixin
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 .

For AWS Region support, see CloudFormation Support for AWS IoT Greengrass 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.

When you create a group, you can optionally include an initial group version. To associate a group version later, create a AWS::Greengrass::GroupVersion 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 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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.greengrass.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object tags;
 CfnGroupPropsMixin cfnGroupPropsMixin = CfnGroupPropsMixin.Builder.create(CfnGroupMixinProps.builder()
         .initialVersion(GroupVersionProperty.builder()
                 .connectorDefinitionVersionArn("connectorDefinitionVersionArn")
                 .coreDefinitionVersionArn("coreDefinitionVersionArn")
                 .deviceDefinitionVersionArn("deviceDefinitionVersionArn")
                 .functionDefinitionVersionArn("functionDefinitionVersionArn")
                 .loggerDefinitionVersionArn("loggerDefinitionVersionArn")
                 .resourceDefinitionVersionArn("resourceDefinitionVersionArn")
                 .subscriptionDefinitionVersionArn("subscriptionDefinitionVersionArn")
                 .build())
         .name("name")
         .roleArn("roleArn")
         .tags(tags)
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnGroupPropsMixin.Builder
    A fluent builder for CfnGroupPropsMixin.
    static interface 
    CfnGroupPropsMixin.GroupVersionProperty
    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.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnGroupPropsMixin(CfnGroupMixinProps props)
    Create a mixin to apply properties to AWS::Greengrass::Group.
     
    CfnGroupPropsMixin(CfnGroupMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::Greengrass::Group.
    protected
    CfnGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnGroupMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnGroupPropsMixin

      protected CfnGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGroupPropsMixin

      protected CfnGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGroupPropsMixin

      @Stability(Stable) public CfnGroupPropsMixin(@NotNull CfnGroupMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Greengrass::Group.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnGroupPropsMixin

      @Stability(Stable) public CfnGroupPropsMixin(@NotNull CfnGroupMixinProps props)
      Create a mixin to apply properties to AWS::Greengrass::Group.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnGroupMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()