[ aws . greengrass ]

update-core-definition

Description

Updates a core definition.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-core-definition
--core-definition-id <value>
[--name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--core-definition-id (string) The ID of the core definition.

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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To update a core definition

The following update-core-definition example changes the name of the specified core definition. You can update only the name property of a core definition.

aws greengrass update-core-definition \
    --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \
    --name "MyCoreDevices"

This command produces no output.

For more information, see Configure the AWS IoT Greengrass Core in the AWS IoT Greengrass Developer Guide.

Output

None