/******************************************************************************* * 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.EC2; using Amazon.EC2.Model; namespace Amazon.PowerShell.Cmdlets.EC2 { /// /// Modify the instance metadata parameters on a running or stopped instance. When you /// modify the parameters on a stopped instance, they are applied when the instance is /// started. When you modify the parameters on a running instance, the API responds with /// a state of “pending”. After the parameter modifications are successfully applied to /// the instance, the state of the modifications changes from “pending” to “applied” in /// subsequent describe-instances API calls. For more information, see Instance /// metadata and user data in the Amazon EC2 User Guide. /// [Cmdlet("Edit", "EC2InstanceMetadataOption", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ModifyInstanceMetadataOptions API operation.", Operation = new[] {"ModifyInstanceMetadataOptions"}, SelectReturnType = typeof(Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse))] [AWSCmdletOutput("Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse", "This cmdlet returns an Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class EditEC2InstanceMetadataOptionCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter HttpEndpoint /// /// /// Enables or disables the HTTP metadata endpoint on your instances. If this parameter /// is not specified, the existing state is maintained.If you specify a value of disabled, you cannot access your instance metadata. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.InstanceMetadataEndpointState")] public Amazon.EC2.InstanceMetadataEndpointState HttpEndpoint { get; set; } #endregion #region Parameter HttpProtocolIpv6 /// /// /// Enables or disables the IPv6 endpoint for the instance metadata service. Applies only /// if you enabled the HTTP metadata endpoint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.InstanceMetadataProtocolState")] public Amazon.EC2.InstanceMetadataProtocolState HttpProtocolIpv6 { get; set; } #endregion #region Parameter HttpPutResponseHopLimit /// /// /// The desired HTTP PUT response hop limit for instance metadata requests. The larger /// the number, the further instance metadata requests can travel. If no parameter is /// specified, the existing state is maintained.Possible values: Integers from 1 to 64 /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? HttpPutResponseHopLimit { get; set; } #endregion #region Parameter HttpToken /// /// /// IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional /// (in other words, set the use of IMDSv2 to optional) or required /// (in other words, set the use of IMDSv2 to required).Default: optional /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("HttpTokens")] [AWSConstantClassSource("Amazon.EC2.HttpTokensState")] public Amazon.EC2.HttpTokensState HttpToken { get; set; } #endregion #region Parameter InstanceId /// /// /// The ID of the instance. /// /// #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 InstanceId { get; set; } #endregion #region Parameter InstanceMetadataTag /// /// /// Set to enabled to allow access to instance tags from the instance metadata. /// Set to disabled to turn off access to instance tags from the instance /// metadata. For more information, see Work /// with instance tags using the instance metadata.Default: disabled /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("InstanceMetadataTags")] [AWSConstantClassSource("Amazon.EC2.InstanceMetadataTagsState")] public Amazon.EC2.InstanceMetadataTagsState InstanceMetadataTag { get; set; } #endregion #region Parameter Select /// /// 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.EC2.Model.ModifyInstanceMetadataOptionsResponse). /// Specifying the name of a property of type Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse will result in that property being returned. /// 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 InstanceId parameter. /// The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceId' 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.InstanceId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-EC2InstanceMetadataOption (ModifyInstanceMetadataOptions)")) { 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.InstanceId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.HttpEndpoint = this.HttpEndpoint; context.HttpProtocolIpv6 = this.HttpProtocolIpv6; context.HttpPutResponseHopLimit = this.HttpPutResponseHopLimit; context.HttpToken = this.HttpToken; context.InstanceId = this.InstanceId; #if MODULAR if (this.InstanceId == null && ParameterWasBound(nameof(this.InstanceId))) { WriteWarning("You are passing $null as a value for parameter InstanceId 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.InstanceMetadataTag = this.InstanceMetadataTag; // 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.EC2.Model.ModifyInstanceMetadataOptionsRequest(); if (cmdletContext.HttpEndpoint != null) { request.HttpEndpoint = cmdletContext.HttpEndpoint; } if (cmdletContext.HttpProtocolIpv6 != null) { request.HttpProtocolIpv6 = cmdletContext.HttpProtocolIpv6; } if (cmdletContext.HttpPutResponseHopLimit != null) { request.HttpPutResponseHopLimit = cmdletContext.HttpPutResponseHopLimit.Value; } if (cmdletContext.HttpToken != null) { request.HttpTokens = cmdletContext.HttpToken; } if (cmdletContext.InstanceId != null) { request.InstanceId = cmdletContext.InstanceId; } if (cmdletContext.InstanceMetadataTag != null) { request.InstanceMetadataTags = cmdletContext.InstanceMetadataTag; } 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.EC2.Model.ModifyInstanceMetadataOptionsResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ModifyInstanceMetadataOptionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ModifyInstanceMetadataOptions"); try { #if DESKTOP return client.ModifyInstanceMetadataOptions(request); #elif CORECLR return client.ModifyInstanceMetadataOptionsAsync(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 Amazon.EC2.InstanceMetadataEndpointState HttpEndpoint { get; set; } public Amazon.EC2.InstanceMetadataProtocolState HttpProtocolIpv6 { get; set; } public System.Int32? HttpPutResponseHopLimit { get; set; } public Amazon.EC2.HttpTokensState HttpToken { get; set; } public System.String InstanceId { get; set; } public Amazon.EC2.InstanceMetadataTagsState InstanceMetadataTag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }