The list of criteria that define when and how to cancel the configuration deployment.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_AbortConfig_CriteriaList |
Amazon.PowerShell.Cmdlets.GGV2.AmazonGreengrassV2ClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Components |
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 Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DeploymentPolicies_ComponentUpdatePolicy_Action |
-ComponentUpdatePolicy_TimeoutInSecond <
Int32>
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
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DeploymentPolicies_ComponentUpdatePolicy_TimeoutInSeconds |
-ConfigurationValidationPolicy_TimeoutInSecond <
Int32>
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
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DeploymentPolicies_ConfigurationValidationPolicy_TimeoutInSeconds |
The name of the deployment.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.Default: ROLLBACK
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ExponentialRate_BaseRatePerMinute <
Int32>
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_JobExecutionsRolloutConfig_ExponentialRate_BaseRatePerMinute |
-ExponentialRate_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).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_JobExecutionsRolloutConfig_ExponentialRate_IncrementFactor |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-JobExecutionsRolloutConfig_MaximumPerMinute <
Int32>
The maximum number of devices that receive a pending job notification, per minute.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_JobExecutionsRolloutConfig_MaximumPerMinute |
The parent deployment's target
ARN within a subdeployment.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the TargetArn parameter. The -PassThru parameter is deprecated, use -Select '^TargetArn' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-RateIncreaseCriteria_NumberOfNotifiedThing <
Int32>
The number of devices to receive the job notification before the rollout rate increases.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_JobExecutionsRolloutConfig_ExponentialRate_RateIncreaseCriteria_NumberOfNotifiedThings |
-RateIncreaseCriteria_NumberOfSucceededThing <
Int32>
The number of devices to successfully run the configuration job before the rollout rate increases.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_JobExecutionsRolloutConfig_ExponentialRate_RateIncreaseCriteria_NumberOfSucceededThings |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GreengrassV2.Model.CreateDeploymentResponse). Specifying the name of a property of type Amazon.GreengrassV2.Model.CreateDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A list of key-value pairs that contain metadata for the resource. For more information, see
Tag your resources in the
IoT Greengrass V2 Developer Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
The
ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
-TimeoutConfig_InProgressTimeoutInMinute <Int64>
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).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IotJobConfiguration_TimeoutConfig_InProgressTimeoutInMinutes |