/******************************************************************************* * 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.ApiGatewayV2; using Amazon.ApiGatewayV2.Model; namespace Amazon.PowerShell.Cmdlets.AG2 { /// /// Updates an Authorizer. /// [Cmdlet("Update", "AG2Authorizer", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ApiGatewayV2.Model.UpdateAuthorizerResponse")] [AWSCmdlet("Calls the Amazon API Gateway V2 UpdateAuthorizer API operation.", Operation = new[] {"UpdateAuthorizer"}, SelectReturnType = typeof(Amazon.ApiGatewayV2.Model.UpdateAuthorizerResponse))] [AWSCmdletOutput("Amazon.ApiGatewayV2.Model.UpdateAuthorizerResponse", "This cmdlet returns an Amazon.ApiGatewayV2.Model.UpdateAuthorizerResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateAG2AuthorizerCmdlet : AmazonApiGatewayV2ClientCmdlet, IExecutor { #region Parameter ApiId /// /// /// The API identifier. /// /// #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 ApiId { get; set; } #endregion #region Parameter JwtConfiguration_Audience /// /// /// A list of the intended recipients of the JWT. A valid JWT must provide an aud that /// matches at least one entry in this list. See RFC /// 7519. Supported only for HTTP APIs. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] JwtConfiguration_Audience { get; set; } #endregion #region Parameter AuthorizerCredentialsArn /// /// /// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. /// To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name /// (ARN). To use resource-based permissions on the Lambda function, don't specify this /// parameter. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AuthorizerCredentialsArn { get; set; } #endregion #region Parameter AuthorizerId /// /// /// The authorizer identifier. /// /// #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 AuthorizerId { get; set; } #endregion #region Parameter AuthorizerPayloadFormatVersion /// /// /// Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required /// for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, /// see Working /// with AWS Lambda authorizers for HTTP APIs. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AuthorizerPayloadFormatVersion { get; set; } #endregion #region Parameter AuthorizerResultTtlInSecond /// /// /// The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, /// authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer /// responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda /// authorizers. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AuthorizerResultTtlInSeconds")] public System.Int32? AuthorizerResultTtlInSecond { get; set; } #endregion #region Parameter AuthorizerType /// /// /// The authorizer type. Specify REQUEST for a Lambda function using incoming request /// parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ApiGatewayV2.AuthorizerType")] public Amazon.ApiGatewayV2.AuthorizerType AuthorizerType { get; set; } #endregion #region Parameter AuthorizerUri /// /// /// The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this /// must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. /// In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} /// , where {region} is the same as the region /// hosting the Lambda function, path indicates that the remaining substring in the URI /// should be treated as the path to the resource, including the initial /. For Lambda /// functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. /// Supported only for REQUEST authorizers. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AuthorizerUri { get; set; } #endregion #region Parameter EnableSimpleResponse /// /// /// Specifies whether a Lambda authorizer returns a response in a simple format. By default, /// a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can /// return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To /// learn more, see Working /// with AWS Lambda authorizers for HTTP APIs /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("EnableSimpleResponses")] public System.Boolean? EnableSimpleResponse { get; set; } #endregion #region Parameter IdentitySource /// /// /// The identity source for which authorization is requested.For a REQUEST authorizer, this is optional. The value is a set of one or more mapping /// expressions of the specified request parameters. The identity source can be headers, /// query string parameters, stage variables, and context parameters. For example, if /// an Auth header and a Name query string parameter are defined as identity sources, /// this value is route.request.header.Auth, route.request.querystring.Name for WebSocket /// APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, /// $request.querystring.Name. These parameters are used to perform runtime validation /// for Lambda-based authorizers by verifying all of the identity-related request parameters /// are present in the request, not null, and non-empty. Only when this is true does the /// authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized /// response without calling the Lambda function. For HTTP APIs, identity sources are /// also used as the cache key when caching is enabled. To learn more, see Working /// with AWS Lambda authorizers for HTTP APIs.For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from /// inbound requests. Currently only header-based and query parameter-based selections /// are supported, for example $request.header.Authorization. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] IdentitySource { get; set; } #endregion #region Parameter IdentityValidationExpression /// /// /// This parameter is not used. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IdentityValidationExpression { get; set; } #endregion #region Parameter JwtConfiguration_Issuer /// /// /// The base domain of the identity provider that issues JSON Web Tokens. For example, /// an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} /// . Required for the JWT authorizer type. Supported only for HTTP APIs. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String JwtConfiguration_Issuer { get; set; } #endregion #region Parameter Name /// /// /// The name of the authorizer. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Name { 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.ApiGatewayV2.Model.UpdateAuthorizerResponse). /// Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateAuthorizerResponse 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 ApiId parameter. /// The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ApiId' 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.AuthorizerId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-AG2Authorizer (UpdateAuthorizer)")) { 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.ApiId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ApiId = this.ApiId; #if MODULAR if (this.ApiId == null && ParameterWasBound(nameof(this.ApiId))) { WriteWarning("You are passing $null as a value for parameter ApiId 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.AuthorizerCredentialsArn = this.AuthorizerCredentialsArn; context.AuthorizerId = this.AuthorizerId; #if MODULAR if (this.AuthorizerId == null && ParameterWasBound(nameof(this.AuthorizerId))) { WriteWarning("You are passing $null as a value for parameter AuthorizerId 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.AuthorizerPayloadFormatVersion = this.AuthorizerPayloadFormatVersion; context.AuthorizerResultTtlInSecond = this.AuthorizerResultTtlInSecond; context.AuthorizerType = this.AuthorizerType; context.AuthorizerUri = this.AuthorizerUri; context.EnableSimpleResponse = this.EnableSimpleResponse; if (this.IdentitySource != null) { context.IdentitySource = new List(this.IdentitySource); } context.IdentityValidationExpression = this.IdentityValidationExpression; if (this.JwtConfiguration_Audience != null) { context.JwtConfiguration_Audience = new List(this.JwtConfiguration_Audience); } context.JwtConfiguration_Issuer = this.JwtConfiguration_Issuer; context.Name = this.Name; // 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.ApiGatewayV2.Model.UpdateAuthorizerRequest(); if (cmdletContext.ApiId != null) { request.ApiId = cmdletContext.ApiId; } if (cmdletContext.AuthorizerCredentialsArn != null) { request.AuthorizerCredentialsArn = cmdletContext.AuthorizerCredentialsArn; } if (cmdletContext.AuthorizerId != null) { request.AuthorizerId = cmdletContext.AuthorizerId; } if (cmdletContext.AuthorizerPayloadFormatVersion != null) { request.AuthorizerPayloadFormatVersion = cmdletContext.AuthorizerPayloadFormatVersion; } if (cmdletContext.AuthorizerResultTtlInSecond != null) { request.AuthorizerResultTtlInSeconds = cmdletContext.AuthorizerResultTtlInSecond.Value; } if (cmdletContext.AuthorizerType != null) { request.AuthorizerType = cmdletContext.AuthorizerType; } if (cmdletContext.AuthorizerUri != null) { request.AuthorizerUri = cmdletContext.AuthorizerUri; } if (cmdletContext.EnableSimpleResponse != null) { request.EnableSimpleResponses = cmdletContext.EnableSimpleResponse.Value; } if (cmdletContext.IdentitySource != null) { request.IdentitySource = cmdletContext.IdentitySource; } if (cmdletContext.IdentityValidationExpression != null) { request.IdentityValidationExpression = cmdletContext.IdentityValidationExpression; } // populate JwtConfiguration var requestJwtConfigurationIsNull = true; request.JwtConfiguration = new Amazon.ApiGatewayV2.Model.JWTConfiguration(); List requestJwtConfiguration_jwtConfiguration_Audience = null; if (cmdletContext.JwtConfiguration_Audience != null) { requestJwtConfiguration_jwtConfiguration_Audience = cmdletContext.JwtConfiguration_Audience; } if (requestJwtConfiguration_jwtConfiguration_Audience != null) { request.JwtConfiguration.Audience = requestJwtConfiguration_jwtConfiguration_Audience; requestJwtConfigurationIsNull = false; } System.String requestJwtConfiguration_jwtConfiguration_Issuer = null; if (cmdletContext.JwtConfiguration_Issuer != null) { requestJwtConfiguration_jwtConfiguration_Issuer = cmdletContext.JwtConfiguration_Issuer; } if (requestJwtConfiguration_jwtConfiguration_Issuer != null) { request.JwtConfiguration.Issuer = requestJwtConfiguration_jwtConfiguration_Issuer; requestJwtConfigurationIsNull = false; } // determine if request.JwtConfiguration should be set to null if (requestJwtConfigurationIsNull) { request.JwtConfiguration = null; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } 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.ApiGatewayV2.Model.UpdateAuthorizerResponse CallAWSServiceOperation(IAmazonApiGatewayV2 client, Amazon.ApiGatewayV2.Model.UpdateAuthorizerRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway V2", "UpdateAuthorizer"); try { #if DESKTOP return client.UpdateAuthorizer(request); #elif CORECLR return client.UpdateAuthorizerAsync(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 ApiId { get; set; } public System.String AuthorizerCredentialsArn { get; set; } public System.String AuthorizerId { get; set; } public System.String AuthorizerPayloadFormatVersion { get; set; } public System.Int32? AuthorizerResultTtlInSecond { get; set; } public Amazon.ApiGatewayV2.AuthorizerType AuthorizerType { get; set; } public System.String AuthorizerUri { get; set; } public System.Boolean? EnableSimpleResponse { get; set; } public List IdentitySource { get; set; } public System.String IdentityValidationExpression { get; set; } public List JwtConfiguration_Audience { get; set; } public System.String JwtConfiguration_Issuer { get; set; } public System.String Name { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }