/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.AutoScaling; using Amazon.AutoScaling.Model; namespace Amazon.PowerShell.Cmdlets.AS { /// /// Records a heartbeat for the lifecycle action associated with the specified token or /// instance. This extends the timeout by the length of time defined using the PutLifecycleHook /// API call. /// /// /// /// This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling /// group: ///
  1. /// (Optional) Create a launch template or launch configuration with a user data script /// that runs while an instance is in a wait state due to a lifecycle hook. ///
  2. /// (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke /// your Lambda function when an instance is put into a wait state due to a lifecycle /// hook. ///
  3. /// (Optional) Create a notification target and an IAM role. The target can be either /// an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling /// to publish lifecycle notifications to the target. ///
  4. /// Create the lifecycle hook. Specify whether the hook is used when the instances launch /// or terminate. ///
  5. If you need more time, record the lifecycle action heartbeat to keep the instance /// in a wait state.
  6. /// If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction /// API call. ///
/// For more information, see Amazon /// EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. /// ///
[Cmdlet("Write", "ASLifecycleActionHeartbeat", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Auto Scaling RecordLifecycleActionHeartbeat API operation.", Operation = new[] {"RecordLifecycleActionHeartbeat"}, SelectReturnType = typeof(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse))] [AWSCmdletOutput("None or Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteASLifecycleActionHeartbeatCmdlet : AmazonAutoScalingClientCmdlet, IExecutor { #region Parameter AutoScalingGroupName /// /// /// The name of the Auto Scaling group. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String AutoScalingGroupName { get; set; } #endregion #region Parameter InstanceId /// /// /// The ID of the instance. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String InstanceId { get; set; } #endregion #region Parameter LifecycleActionToken /// /// /// A token that uniquely identifies a specific lifecycle action associated with an instance. /// Amazon EC2 Auto Scaling sends this token to the notification target that you specified /// when you created the lifecycle hook. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LifecycleActionToken { get; set; } #endregion #region Parameter LifecycleHookName /// /// /// The name of the lifecycle hook. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String LifecycleHookName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse). /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the AutoScalingGroupName parameter. /// The -PassThru parameter is deprecated, use -Select '^AutoScalingGroupName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AutoScalingGroupName' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.AutoScalingGroupName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-ASLifecycleActionHeartbeat (RecordLifecycleActionHeartbeat)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.AutoScalingGroupName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AutoScalingGroupName = this.AutoScalingGroupName; #if MODULAR if (this.AutoScalingGroupName == null && ParameterWasBound(nameof(this.AutoScalingGroupName))) { WriteWarning("You are passing $null as a value for parameter AutoScalingGroupName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.InstanceId = this.InstanceId; context.LifecycleActionToken = this.LifecycleActionToken; context.LifecycleHookName = this.LifecycleHookName; #if MODULAR if (this.LifecycleHookName == null && ParameterWasBound(nameof(this.LifecycleHookName))) { WriteWarning("You are passing $null as a value for parameter LifecycleHookName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest(); if (cmdletContext.AutoScalingGroupName != null) { request.AutoScalingGroupName = cmdletContext.AutoScalingGroupName; } if (cmdletContext.InstanceId != null) { request.InstanceId = cmdletContext.InstanceId; } if (cmdletContext.LifecycleActionToken != null) { request.LifecycleActionToken = cmdletContext.LifecycleActionToken; } if (cmdletContext.LifecycleHookName != null) { request.LifecycleHookName = cmdletContext.LifecycleHookName; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse CallAWSServiceOperation(IAmazonAutoScaling client, Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Auto Scaling", "RecordLifecycleActionHeartbeat"); try { #if DESKTOP return client.RecordLifecycleActionHeartbeat(request); #elif CORECLR return client.RecordLifecycleActionHeartbeatAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.String AutoScalingGroupName { get; set; } public System.String InstanceId { get; set; } public System.String LifecycleActionToken { get; set; } public System.String LifecycleHookName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }