Indicates whether the change request can be approved automatically without the need for manual approvals.If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ChangeDetails |
The name of the change request associated with the runbook workflow to be run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.SSM.AmazonSimpleSystemsManagementClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the change template document to run during the runbook workflow.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
The version of the change template document to run during the runbook workflow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
A key-value map of parameters that match the declared parameters in the change template document.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Parameters |
Changes the cmdlet behavior to return the value passed to the DocumentName parameter. The -PassThru parameter is deprecated, use -Select '^DocumentName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Information about the Automation runbooks that are run during the runbook workflow.The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Runbooks |
-ScheduledEndTime <DateTime>
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ScheduledTime <DateTime>
The date and time specified in the change request to run the Automation runbooks.The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'AutomationExecutionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.StartChangeRequestExecutionResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.StartChangeRequestExecutionResponse 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) |
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
- Key=Environment,Value=Production
- Key=Region,Value=us-east-2
The
Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the
StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the
AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |