Show / Hide Table of Contents

Class CfnGroupPropsMixin

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.

Inheritance
object
Mixin
CfnGroupPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Greengrass
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnGroupPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnGroupPropsMixin Inherits Mixin Implements IMixin
Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Greengrass;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;
             var tags;

             var cfnGroupPropsMixin = new CfnGroupPropsMixin(new CfnGroupMixinProps {
                 InitialVersion = new GroupVersionProperty {
                     ConnectorDefinitionVersionArn = "connectorDefinitionVersionArn",
                     CoreDefinitionVersionArn = "coreDefinitionVersionArn",
                     DeviceDefinitionVersionArn = "deviceDefinitionVersionArn",
                     FunctionDefinitionVersionArn = "functionDefinitionVersionArn",
                     LoggerDefinitionVersionArn = "loggerDefinitionVersionArn",
                     ResourceDefinitionVersionArn = "resourceDefinitionVersionArn",
                     SubscriptionDefinitionVersionArn = "subscriptionDefinitionVersionArn"
                 },
                 Name = "name",
                 RoleArn = "roleArn",
                 Tags = tags
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnGroupPropsMixin(ICfnGroupMixinProps, ICfnPropertyMixinOptions?)

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

Properties

CFN_PROPERTY_KEYS

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.

Props

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.

Strategy

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.

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnGroupPropsMixin(ICfnGroupMixinProps, ICfnPropertyMixinOptions?)

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

public CfnGroupPropsMixin(ICfnGroupMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnGroupMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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.

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Greengrass;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;
             var tags;

             var cfnGroupPropsMixin = new CfnGroupPropsMixin(new CfnGroupMixinProps {
                 InitialVersion = new GroupVersionProperty {
                     ConnectorDefinitionVersionArn = "connectorDefinitionVersionArn",
                     CoreDefinitionVersionArn = "coreDefinitionVersionArn",
                     DeviceDefinitionVersionArn = "deviceDefinitionVersionArn",
                     FunctionDefinitionVersionArn = "functionDefinitionVersionArn",
                     LoggerDefinitionVersionArn = "loggerDefinitionVersionArn",
                     ResourceDefinitionVersionArn = "resourceDefinitionVersionArn",
                     SubscriptionDefinitionVersionArn = "subscriptionDefinitionVersionArn"
                 },
                 Name = "name",
                 RoleArn = "roleArn",
                 Tags = tags
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

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.

protected virtual ICfnGroupMixinProps Props { get; }
Property Value

ICfnGroupMixinProps

Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Greengrass;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;
             var tags;

             var cfnGroupPropsMixin = new CfnGroupPropsMixin(new CfnGroupMixinProps {
                 InitialVersion = new GroupVersionProperty {
                     ConnectorDefinitionVersionArn = "connectorDefinitionVersionArn",
                     CoreDefinitionVersionArn = "coreDefinitionVersionArn",
                     DeviceDefinitionVersionArn = "deviceDefinitionVersionArn",
                     FunctionDefinitionVersionArn = "functionDefinitionVersionArn",
                     LoggerDefinitionVersionArn = "loggerDefinitionVersionArn",
                     ResourceDefinitionVersionArn = "resourceDefinitionVersionArn",
                     SubscriptionDefinitionVersionArn = "subscriptionDefinitionVersionArn"
                 },
                 Name = "name",
                 RoleArn = "roleArn",
                 Tags = tags
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

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.

protected virtual IMergeStrategy Strategy { get; }
Property Value

IMergeStrategy

Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Greengrass;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;
             var tags;

             var cfnGroupPropsMixin = new CfnGroupPropsMixin(new CfnGroupMixinProps {
                 InitialVersion = new GroupVersionProperty {
                     ConnectorDefinitionVersionArn = "connectorDefinitionVersionArn",
                     CoreDefinitionVersionArn = "coreDefinitionVersionArn",
                     DeviceDefinitionVersionArn = "deviceDefinitionVersionArn",
                     FunctionDefinitionVersionArn = "functionDefinitionVersionArn",
                     LoggerDefinitionVersionArn = "loggerDefinitionVersionArn",
                     ResourceDefinitionVersionArn = "resourceDefinitionVersionArn",
                     SubscriptionDefinitionVersionArn = "subscriptionDefinitionVersionArn"
                 },
                 Name = "name",
                 RoleArn = "roleArn",
                 Tags = tags
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Overrides
Mixin.ApplyTo(IConstruct)
Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Mixin.Supports(IConstruct)
Remarks

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 <a href="https://docs.aws.amazon.com/greengrass/v1/developerguide/cloudformation-support.html">CloudFormation Support for AWS IoT Greengrass</a> in the <em>Developer Guide</em> .

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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html"><code>AWS::Greengrass::GroupVersion</code></a> 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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

CloudformationResource: AWS::Greengrass::Group

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin
Back to top Generated by DocFX