aws_greengrass_deployment

account_id

Type: STRING

components

Type: STRING
Provider name: components
Description: 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.

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: The time at which the deployment was created, expressed in ISO 8601 format.

deployment_id

Type: STRING
Provider name: deploymentId
Description: The ID of the deployment.

deployment_name

Type: STRING
Provider name: deploymentName
Description: The name of the deployment.

deployment_policies

Type: STRUCT
Provider name: deploymentPolicies
Description: The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

• component_update_policy
  Type: STRUCT
  Provider name: componentUpdatePolicy
  Description: The component update policy for the configuration deployment. This policy defines when it’s safe to deploy the configuration to devices.
  
  • action
    Type: STRING
    Provider name: action
    Description: 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 Create deployments in the 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
  • timeout_in_seconds
    Type: INT32
    Provider name: timeoutInSeconds
    Description: 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
• configuration_validation_policy
  Type: STRUCT
  Provider name: configurationValidationPolicy
  Description: The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.
  
  • timeout_in_seconds
    Type: INT32
    Provider name: timeoutInSeconds
    Description: 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
• failure_handling_policy
  Type: STRING
  Provider name: failureHandlingPolicy
  Description: The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.
  Default: ROLLBACK

deployment_status

Type: STRING
Provider name: deploymentStatus
Description: The status of the deployment.

iot_job_arn

Type: STRING
Provider name: iotJobArn
Description: The ARN of the IoT job that applies the deployment to target devices.

iot_job_configuration

Type: STRUCT
Provider name: iotJobConfiguration
Description: The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

• abort_config
  Type: STRUCT
  Provider name: abortConfig
  Description: The stop configuration for the job. This configuration defines when and how to stop a job rollout.
  
  • criteria_list
    Type: UNORDERED_LIST_STRUCT
    Provider name: criteriaList
    Description: The list of criteria that define when and how to cancel the configuration deployment.
    
    • action
      Type: STRING
      Provider name: action
      Description: The action to perform when the criteria are met.
      
    • failure_type
      Type: STRING
      Provider name: failureType
      Description: The type of job deployment failure that can cancel a job.
      
    • min_number_of_executed_things
      Type: INT32
      Provider name: minNumberOfExecutedThings
      Description: The minimum number of things that receive the configuration before the job can cancel.
      
    • threshold_percentage
      Type: DOUBLE
      Provider name: thresholdPercentage
      Description: 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).
      
• job_executions_rollout_config
  Type: STRUCT
  Provider name: jobExecutionsRolloutConfig
  Description: The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.
  
  • exponential_rate
    Type: STRUCT
    Provider name: exponentialRate
    Description: The exponential rate to increase the job rollout rate.
    
    • base_rate_per_minute
      Type: INT32
      Provider name: baseRatePerMinute
      Description: 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.
      
    • increment_factor
      Type: DOUBLE
      Provider name: incrementFactor
      Description: 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).
      
    • rate_increase_criteria
      Type: STRUCT
      Provider name: rateIncreaseCriteria
      Description: The criteria to increase the rollout rate for the job.
      
      • number_of_notified_things
        Type: INT32
        Provider name: numberOfNotifiedThings
        Description: The number of devices to receive the job notification before the rollout rate increases.
        
      • number_of_succeeded_things
        Type: INT32
        Provider name: numberOfSucceededThings
        Description: The number of devices to successfully run the configuration job before the rollout rate increases.
        
  • maximum_per_minute
    Type: INT32
    Provider name: maximumPerMinute
    Description: The maximum number of devices that receive a pending job notification, per minute.
    
• timeout_config
  Type: STRUCT
  Provider name: timeoutConfig
  Description: The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.
  
  • in_progress_timeout_in_minutes
    Type: INT64
    Provider name: inProgressTimeoutInMinutes
    Description: 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).
    

iot_job_id

Type: STRING
Provider name: iotJobId
Description: The ID of the IoT job that applies the deployment to target devices.

is_latest_for_target

Type: BOOLEAN
Provider name: isLatestForTarget
Description: Whether or not the deployment is the latest revision for its target.

parent_target_arn

Type: STRING
Provider name: parentTargetArn
Description: The parent deployment’s target ARN within a subdeployment.

revision_id

Type: STRING
Provider name: revisionId
Description: The revision number of the deployment.

tags

Type: UNORDERED_LIST_STRING

target_arn

Type: STRING
Provider name: targetArn
Description: The ARN of the target IoT thing or thing group.