software.amazon.awscdk.services.greengrass

Class CfnGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.greengrass.CfnGroup

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.153Z")
 @Stability(value=Stable)
public class CfnGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::Group`.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrass.*;
 Object tags;
 CfnGroup cfnGroup = CfnGroup.Builder.create(this, "MyCfnGroup")
         .name("name")
         // the properties below are optional
         .initialVersion(GroupVersionProperty.builder()
                 .connectorDefinitionVersionArn("connectorDefinitionVersionArn")
                 .coreDefinitionVersionArn("coreDefinitionVersionArn")
                 .deviceDefinitionVersionArn("deviceDefinitionVersionArn")
                 .functionDefinitionVersionArn("functionDefinitionVersionArn")
                 .loggerDefinitionVersionArn("loggerDefinitionVersionArn")
                 .resourceDefinitionVersionArn("resourceDefinitionVersionArn")
                 .subscriptionDefinitionVersionArn("subscriptionDefinitionVersionArn")
                 .build())
         .roleArn("roleArn")
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGroup.Builder A fluent builder for CfnGroup.
static interface	CfnGroup.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.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGroup(Construct scope, String id, CfnGroupProps props) Create a new `AWS::Greengrass::Group`.
protected	CfnGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the `Group` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
String	getAttrId() The ID of the `Group` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
String	getAttrLatestVersionArn() 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` .
String	getAttrName() The name of the `Group` , such as `MyGroup` .
String	getAttrRoleArn() The ARN of the IAM role that's attached to the `Group` , such as `arn:aws:iam:: :role/role-name` .
String	getAttrRoleAttachedAt() The time (in milliseconds since the epoch) when the group role was attached to the `Group` .
protected Map<String,Object>	getCfnProperties()
Object	getInitialVersion() The group version to include when the group is created.
String	getName() The name of the group.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role attached to the group.
TagManager	getTags() Application-specific metadata to attach to the group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInitialVersion(CfnGroup.GroupVersionProperty value) The group version to include when the group is created.
void	setInitialVersion(IResolvable value) The group version to include when the group is created.
void	setName(String value) The name of the group.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of the IAM role attached to the group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGroup

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

CfnGroup

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

CfnGroup

@Stability(value=Stable)
public CfnGroup(@NotNull
                                         Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnGroupProps props)

Create a new `AWS::Greengrass::Group`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the `Group` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the `Group` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .

getAttrLatestVersionArn

@Stability(value=Stable)
 @NotNull
public String getAttrLatestVersionArn()

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

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the `Group` , such as `MyGroup` .

getAttrRoleArn

@Stability(value=Stable)
 @NotNull
public String getAttrRoleArn()

The ARN of the IAM role that's attached to the `Group` , such as `arn:aws:iam:: :role/role-name` .

getAttrRoleAttachedAt

@Stability(value=Stable)
 @NotNull
public String getAttrRoleAttachedAt()

The time (in milliseconds since the epoch) when the group role was attached to the `Group` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Application-specific metadata to attach to the group.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates.

 "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
 }
 

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the group.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the group.

getInitialVersion

@Stability(value=Stable)
 @Nullable
public Object getInitialVersion()

The group version to include when the group is created.

A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.

To associate a group version after the group is created, create an AWS::Greengrass::GroupVersion resource and specify the ID of this group.

setInitialVersion

@Stability(value=Stable)
public void setInitialVersion(@Nullable
                                                       IResolvable value)

The group version to include when the group is created.

A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.

To associate a group version after the group is created, create an AWS::Greengrass::GroupVersion resource and specify the ID of this group.

setInitialVersion

@Stability(value=Stable)
public void setInitialVersion(@Nullable
                                                       CfnGroup.GroupVersionProperty value)

The group version to include when the group is created.

A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.

To associate a group version after the group is created, create an AWS::Greengrass::GroupVersion resource and specify the ID of this group.

getRoleArn

@Stability(value=Stable)
 @Nullable
public String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role attached to the group.

This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                String value)

The Amazon Resource Name (ARN) of the IAM role attached to the group.

This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.