class CfnGroupPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Greengrass.Mixins.CfnGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgreengrass/mixins#CfnGroupPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.greengrass.mixins.CfnGroupPropsMixin
Python	aws_cdk.mixins_preview.aws_greengrass.mixins.CfnGroupPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_greengrass » mixins » CfnGroupPropsMixin

Implements IMixin

Extends 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 .

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 .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as greengrass_mixins } from '@aws-cdk/mixins-preview/aws-greengrass';

declare const tags: any;
const cfnGroupPropsMixin = new greengrass_mixins.CfnGroupPropsMixin({
  initialVersion: {
    connectorDefinitionVersionArn: 'connectorDefinitionVersionArn',
    coreDefinitionVersionArn: 'coreDefinitionVersionArn',
    deviceDefinitionVersionArn: 'deviceDefinitionVersionArn',
    functionDefinitionVersionArn: 'functionDefinitionVersionArn',
    loggerDefinitionVersionArn: 'loggerDefinitionVersionArn',
    resourceDefinitionVersionArn: 'resourceDefinitionVersionArn',
    subscriptionDefinitionVersionArn: 'subscriptionDefinitionVersionArn',
  },
  name: 'name',
  roleArn: 'roleArn',
  tags: tags,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnGroupPropsMixin(props: CfnGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.