[ aws . greengrass ]

create-group

Description

Creates a group. You may provide the initial version of the group or use ‘’CreateGroupVersion’’ at a later time. Tip: You can use the ‘’gg_group_setup’’ package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-group
[--amzn-client-token <value>]
[--initial-version <value>]
[--name <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--amzn-client-token (string) A client token used to correlate requests and responses.

--initial-version (structure) Information about the initial version of the group.ConnectorDefinitionVersionArn -> (string)

The ARN of the connector definition version for this group.

CoreDefinitionVersionArn -> (string)

The ARN of the core definition version for this group.

DeviceDefinitionVersionArn -> (string)

The ARN of the device definition version for this group.

FunctionDefinitionVersionArn -> (string)

The ARN of the function definition version for this group.

LoggerDefinitionVersionArn -> (string)

The ARN of the logger definition version for this group.

ResourceDefinitionVersionArn -> (string)

The ARN of the resource definition version for this group.

SubscriptionDefinitionVersionArn -> (string)

The ARN of the subscription definition version for this group.

Shorthand Syntax:

ConnectorDefinitionVersionArn=string,CoreDefinitionVersionArn=string,DeviceDefinitionVersionArn=string,FunctionDefinitionVersionArn=string,LoggerDefinitionVersionArn=string,ResourceDefinitionVersionArn=string,SubscriptionDefinitionVersionArn=string

JSON Syntax:

{
  "ConnectorDefinitionVersionArn": "string",
  "CoreDefinitionVersionArn": "string",
  "DeviceDefinitionVersionArn": "string",
  "FunctionDefinitionVersionArn": "string",
  "LoggerDefinitionVersionArn": "string",
  "ResourceDefinitionVersionArn": "string",
  "SubscriptionDefinitionVersionArn": "string"
}

--name (string) The name of the group.

--tags (map) Tag(s) to add to the new resource.key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a Greeengrass group

The following create-group example creates a group named cli-created-group.

aws greengrass create-group \
    --name cli-created-group

Output:

{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/4e22bd92-898c-436b-ade5-434d883ff749",
    "CreationTimestamp": "2019-06-25T18:07:17.688Z",
    "Id": "4e22bd92-898c-436b-ade5-434d883ff749",
    "LastUpdatedTimestamp": "2019-06-25T18:07:17.688Z",
    "Name": "cli-created-group"
}

For more information, see Overview of the AWS IoT Greengrass Group Object Model in the AWS IoT Greengrass Developer Guide.

Output

Arn -> (string)

The ARN of the definition.

CreationTimestamp -> (string)

The time, in milliseconds since the epoch, when the definition was created.

Id -> (string)

The ID of the definition.

LastUpdatedTimestamp -> (string)

The time, in milliseconds since the epoch, when the definition was last updated.

LatestVersion -> (string)

The ID of the latest version associated with the definition.

LatestVersionArn -> (string)

The ARN of the latest version associated with the definition.

Name -> (string)

The name of the definition.