AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS GreengrassV2 CreateDeployment API operation.

Syntax

New-GGV2Deployment
-TargetArn <String>
-ComponentUpdatePolicy_Action <DeploymentComponentUpdatePolicyAction>
-ExponentialRate_BaseRatePerMinute <Int32>
-Component <Hashtable>
-AbortConfig_CriteriaList <IoTJobAbortCriteria[]>
-DeploymentName <String>
-DeploymentPolicies_FailureHandlingPolicy <DeploymentFailureHandlingPolicy>
-ExponentialRate_IncrementFactor <Double>
-TimeoutConfig_InProgressTimeoutInMinute <Int64>
-JobExecutionsRolloutConfig_MaximumPerMinute <Int32>
-RateIncreaseCriteria_NumberOfNotifiedThing <Int32>
-RateIncreaseCriteria_NumberOfSucceededThing <Int32>
-ParentTargetArn <String>
-Tag <Hashtable>
-ComponentUpdatePolicy_TimeoutInSecond <Int32>
-ConfigurationValidationPolicy_TimeoutInSecond <Int32>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonGreengrassV2Config>

Description

Creates a continuous deployment for a target, which is a 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, 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. 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. For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.

Parameters

-AbortConfig_CriteriaList <IoTJobAbortCriteria[]>
The list of criteria that define when and how to cancel the configuration deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIotJobConfiguration_AbortConfig_CriteriaList
-ClientConfig <AmazonGreengrassV2Config>
Amazon.PowerShell.Cmdlets.GGV2.AmazonGreengrassV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
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)
-Component <Hashtable>
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)
AliasesComponents
-ComponentUpdatePolicy_Action <DeploymentComponentUpdatePolicyAction>
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)
AliasesDeploymentPolicies_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)
AliasesDeploymentPolicies_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)
AliasesDeploymentPolicies_ConfigurationValidationPolicy_TimeoutInSeconds
-DeploymentName <String>
The name of the deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentPolicies_FailureHandlingPolicy <DeploymentFailureHandlingPolicy>
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)
AliasesIotJobConfiguration_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)
AliasesIotJobConfiguration_JobExecutionsRolloutConfig_ExponentialRate_IncrementFactor
-Force <SwitchParameter>
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)
AliasesIotJobConfiguration_JobExecutionsRolloutConfig_MaximumPerMinute
-ParentTargetArn <String>
The parent deployment's target ARN within a subdeployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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)
AliasesIotJobConfiguration_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)
AliasesIotJobConfiguration_JobExecutionsRolloutConfig_ExponentialRate_RateIncreaseCriteria_NumberOfSucceededThings
-Select <String>
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)
-Tag <Hashtable>
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)
AliasesTags
-TargetArn <String>
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)
AliasesIotJobConfiguration_TimeoutConfig_InProgressTimeoutInMinutes

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.GreengrassV2.Model.CreateDeploymentResponse
This cmdlet returns an Amazon.GreengrassV2.Model.CreateDeploymentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z