This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Greengrass::GroupVersion
The AWS::Greengrass::GroupVersion resource represents a group version in
AWS IoT Greengrass. A group version references 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. The group version must
reference a core definition version that contains one core. Other version types are
optionally included, depending on your business need.
Note
To create a group version, you must specify the ID of the group that you want to
associate with the version. For information about creating a group, see AWS::Greengrass::Group.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Greengrass::GroupVersion", "Properties" : { "ConnectorDefinitionVersionArn" :String, "CoreDefinitionVersionArn" :String, "DeviceDefinitionVersionArn" :String, "FunctionDefinitionVersionArn" :String, "GroupId" :String, "LoggerDefinitionVersionArn" :String, "ResourceDefinitionVersionArn" :String, "SubscriptionDefinitionVersionArn" :String} }
YAML
Type: AWS::Greengrass::GroupVersion Properties: ConnectorDefinitionVersionArn:StringCoreDefinitionVersionArn:StringDeviceDefinitionVersionArn:StringFunctionDefinitionVersionArn:StringGroupId:StringLoggerDefinitionVersionArn:StringResourceDefinitionVersionArn:StringSubscriptionDefinitionVersionArn:String
Properties
ConnectorDefinitionVersionArn-
The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.
Required: No
Type: String
Update requires: Replacement
CoreDefinitionVersionArn-
The ARN of the core definition version that contains the core you want to deploy with the group version. Currently, the core definition version can contain only one core.
Required: No
Type: String
Update requires: Replacement
DeviceDefinitionVersionArn-
The ARN of the device definition version that contains the devices you want to deploy with the group version.
Required: No
Type: String
Update requires: Replacement
FunctionDefinitionVersionArn-
The ARN of the function definition version that contains the functions you want to deploy with the group version.
Required: No
Type: String
Update requires: Replacement
GroupId-
The ID of the group associated with this version. This value is a GUID.
Required: Yes
Type: String
Update requires: Replacement
LoggerDefinitionVersionArn-
The ARN of the logger definition version that contains the loggers you want to deploy with the group version.
Required: No
Type: String
Update requires: Replacement
ResourceDefinitionVersionArn-
The ARN of the resource definition version that contains the resources you want to deploy with the group version.
Required: No
Type: String
Update requires: Replacement
SubscriptionDefinitionVersionArn-
The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.
Required: No
Type: String
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the group version, such as
arn:aws:greengrass:us-east-1:123456789012:/greengrass/definition/groups/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2.
For more information about using the Ref function, see Ref.
Fn::GetAtt
See also
-
CreateGroupVersion in the AWS IoT Greengrass Version 1 API Reference