create-deployment¶

Description¶

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group’s deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Synopsis¶

  create-deployment
--target-arn <value>
[--deployment-name <value>]
[--components <value>]
[--iot-job-configuration <value>]
[--deployment-policies <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--target-arn (string)

The ARN of the target AWS IoT thing or thing group.

--deployment-name (string)

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName> , where targetType and targetName are the type and name of the deployment target.

--components (map)

The components to deploy. This is a dictionary, where each key is the name of a component, and each key’s value is the version and configuration to deploy for that component.

key -> (string)

value -> (structure)

Contains information about a component to deploy.

componentVersion -> (string)

The version of the component.

configurationUpdate -> (structure)

The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device’s component configuration with the keys and values that you specify. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the AWS IoT Greengrass V2 Developer Guide .

merge -> (string)

A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component’s existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component’s default configuration. This means that the core device keeps it’s existing configuration for keys and values that you don’t specify in this object. For more information, see Merge configuration updates in the AWS IoT Greengrass V2 Developer Guide .

reset -> (list)

The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (/ ) and use forward slashes to separate the key for each level in the object. For more information, see the JSON pointer specification and Reset configuration updates in the AWS IoT Greengrass V2 Developer Guide .

(string)

runWith -> (structure)

The system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the AWS IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide .

posixUser -> (string)

The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon (: ) in the following format: user:group . The group is optional. If you don’t specify a group, the AWS IoT Greengrass Core software uses the primary user for the group.

Shorthand Syntax:

KeyName1=componentVersion=string,configurationUpdate={merge=string,reset=[string,string]},runWith={posixUser=string},KeyName2=componentVersion=string,configurationUpdate={merge=string,reset=[string,string]},runWith={posixUser=string}

JSON Syntax:

{"string": {
      "componentVersion": "string",
      "configurationUpdate": {
        "merge": "string",
        "reset": ["string", ...]
      },
      "runWith": {
        "posixUser": "string"
      }
    }
  ...}

--iot-job-configuration (structure)

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

jobExecutionsRolloutConfig -> (structure)

The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.

exponentialRate -> (structure)

The exponential rate to increase the job rollout rate.

baseRatePerMinute -> (integer)

The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.

incrementFactor -> (double)

The exponential factor to increase the rollout rate for the job.

This parameter supports up to one digit after the decimal (for example, you can specify 1.5 , but not 1.55 ).

rateIncreaseCriteria -> (structure)

The criteria to increase the rollout rate for the job.

numberOfNotifiedThings -> (integer)

The number of devices to receive the job notification before the rollout rate increases.

numberOfSucceededThings -> (integer)

The number of devices to successfully run the configuration job before the rollout rate increases.

maximumPerMinute -> (integer)

The maximum number of devices that receive a pending job notification, per minute.

abortConfig -> (structure)

The stop configuration for the job. This configuration defines when and how to stop a job rollout.

criteriaList -> (list)

The list of criteria that define when and how to cancel the configuration deployment.

(structure)

Contains criteria that define when and how to cancel a job.

The deployment stops if the following conditions are true:

The number of things that receive the deployment exceeds the minNumberOfExecutedThings .

The percentage of failures with type failureType exceeds the thresholdPercentage .

failureType -> (string)

The type of job deployment failure that can cancel a job.

action -> (string)

The action to perform when the criteria are met.

thresholdPercentage -> (double)

The minimum percentage of failureType failures that occur before the job can cancel.

This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99 , but not 10.999 ).

minNumberOfExecutedThings -> (integer)

The minimum number of things that receive the configuration before the job can cancel.

timeoutConfig -> (structure)

The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.

inProgressTimeoutInMinutes -> (long)

The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to IN_PROGRESS . If the job status doesn’t change to a terminal state before the time expires, then the job status is set to TIMED_OUT .

The timeout interval must be between 1 minute and 7 days (10080 minutes).

JSON Syntax:

{
  "jobExecutionsRolloutConfig": {
    "exponentialRate": {
      "baseRatePerMinute": integer,
      "incrementFactor": double,
      "rateIncreaseCriteria": {
        "numberOfNotifiedThings": integer,
        "numberOfSucceededThings": integer
      }
    },
    "maximumPerMinute": integer
  },
  "abortConfig": {
    "criteriaList": [
      {
        "failureType": "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL",
        "action": "CANCEL",
        "thresholdPercentage": double,
        "minNumberOfExecutedThings": integer
      }
      ...
    ]
  },
  "timeoutConfig": {
    "inProgressTimeoutInMinutes": long
  }
}

--deployment-policies (structure)

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

failureHandlingPolicy -> (string)

The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

Default: ROLLBACK

componentUpdatePolicy -> (structure)

The component update policy for the configuration deployment. This policy defines when it’s safe to deploy the configuration to devices.

timeoutInSeconds -> (integer)

The amount of time in seconds that each component on a device has to report that it’s safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60

action -> (string)

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

SKIP_NOTIFY_COMPONENTS – The deployment doesn’t notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

configurationValidationPolicy -> (structure)

The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.

timeoutInSeconds -> (integer)

The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.

Default: 30

Shorthand Syntax:

failureHandlingPolicy=string,componentUpdatePolicy={timeoutInSeconds=integer,action=string},configurationValidationPolicy={timeoutInSeconds=integer}

JSON Syntax:

{
  "failureHandlingPolicy": "ROLLBACK"|"DO_NOTHING",
  "componentUpdatePolicy": {
    "timeoutInSeconds": integer,
    "action": "NOTIFY_COMPONENTS"|"SKIP_NOTIFY_COMPONENTS"
  },
  "configurationValidationPolicy": {
    "timeoutInSeconds": integer
  }
}

--tags (map)

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide .

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.

Output¶

deploymentId -> (string)

The ID of the deployment.

iotJobId -> (string)

The ID of the AWS IoT job that applies the deployment to target devices.

iotJobArn -> (string)

The ARN of the AWS IoT job that applies the deployment to target devices.

Table of Contents

Feedback

User Guide

create-deployment¶

Description¶

Synopsis¶

Options¶

Output¶