Class CfnGroup
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.
Inherited Members
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IInspectable, ITaggable
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 AWS 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 AWS 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 AWS 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
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.AWS.Greengrass;
var tags;
var cfnGroup = new CfnGroup(this, "MyCfnGroup", new CfnGroupProps {
Name = "name",
// the properties below are optional
InitialVersion = new GroupVersionProperty {
ConnectorDefinitionVersionArn = "connectorDefinitionVersionArn",
CoreDefinitionVersionArn = "coreDefinitionVersionArn",
DeviceDefinitionVersionArn = "deviceDefinitionVersionArn",
FunctionDefinitionVersionArn = "functionDefinitionVersionArn",
LoggerDefinitionVersionArn = "loggerDefinitionVersionArn",
ResourceDefinitionVersionArn = "resourceDefinitionVersionArn",
SubscriptionDefinitionVersionArn = "subscriptionDefinitionVersionArn"
},
RoleArn = "roleArn",
Tags = tags
});
Synopsis
Constructors
CfnGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnGroup(Construct, String, ICfnGroupProps) |
Properties
AttrArn | The ARN of the |
AttrId | The ID of the |
AttrLatestVersionArn | The ARN of the last |
AttrName | The name of the |
AttrRoleArn | The ARN of the IAM role that's attached to the |
AttrRoleAttachedAt | The time (in milliseconds since the epoch) when the group role was attached to the |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
InitialVersion | The group version to include when the group is created. |
Name | The name of the group. |
RoleArn | The Amazon Resource Name (ARN) of the IAM role attached to the group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Application-specific metadata to attach to the group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnGroup(Construct, String, ICfnGroupProps)
public CfnGroup(Construct scope, string id, ICfnGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnGroupProps
Resource properties.
Properties
AttrArn
The ARN of the Group
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The ID of the Group
, such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrLatestVersionArn
The ARN of the last GroupVersion
that was added to the Group
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2
.
public virtual string AttrLatestVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LatestVersionArn
AttrName
The name of the Group
, such as MyGroup
.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
AttrRoleArn
The ARN of the IAM role that's attached to the Group
, such as arn:aws:iam:: :role/role-name
.
public virtual string AttrRoleArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RoleArn
AttrRoleAttachedAt
The time (in milliseconds since the epoch) when the group role was attached to the Group
.
public virtual string AttrRoleAttachedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RoleAttachedAt
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
InitialVersion
The group version to include when the group is created.
public virtual object InitialVersion { get; set; }
Property Value
System.Object
Name
The name of the group.
public virtual string Name { get; set; }
Property Value
System.String
RoleArn
The Amazon Resource Name (ARN) of the IAM role attached to the group.
public virtual string RoleArn { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Application-specific metadata to attach to the group.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>