/******************************************************************************* * 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.APIGateway; using Amazon.APIGateway.Model; namespace Amazon.PowerShell.Cmdlets.AG { /// /// Sets up a method's integration. /// [Cmdlet("Write", "AGIntegration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.APIGateway.Model.PutIntegrationResponse")] [AWSCmdlet("Calls the Amazon API Gateway PutIntegration API operation.", Operation = new[] {"PutIntegration"}, SelectReturnType = typeof(Amazon.APIGateway.Model.PutIntegrationResponse))] [AWSCmdletOutput("Amazon.APIGateway.Model.PutIntegrationResponse", "This cmdlet returns an Amazon.APIGateway.Model.PutIntegrationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteAGIntegrationCmdlet : AmazonAPIGatewayClientCmdlet, IExecutor { #region Parameter CacheKeyParameter /// /// /// A list of request parameters whose values API Gateway caches. To be valid values for /// cacheKeyParameters, these parameters must also be specified for Method /// requestParameters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CacheKeyParameters")] public System.String[] CacheKeyParameter { get; set; } #endregion #region Parameter CacheNamespace /// /// /// Specifies a group of related cached parameters. By default, API Gateway uses the resource /// ID as the cacheNamespace. You can specify the same cacheNamespace /// across resources to return the same cached data for requests to different resources. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String CacheNamespace { get; set; } #endregion #region Parameter ConnectionId /// /// /// The ID of the VpcLink used for the integration. Specify this value only if you specify /// VPC_LINK as the connection type. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ConnectionId { get; set; } #endregion #region Parameter ConnectionType /// /// /// The type of the network connection to the integration endpoint. The valid value is /// INTERNET for connections through the public routable internet or VPC_LINK /// for private connections between API Gateway and a network load balancer in a VPC. /// The default value is INTERNET. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.APIGateway.ConnectionType")] public Amazon.APIGateway.ConnectionType ConnectionType { get; set; } #endregion #region Parameter ContentHandling /// /// /// Specifies how to handle request payload content type conversions. Supported values /// are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following /// behaviors:If this property is not defined, the request payload will be passed through from the /// method request to integration request without modification, provided that the passthroughBehavior /// is configured to support payload pass-through. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.APIGateway.ContentHandlingStrategy")] public Amazon.APIGateway.ContentHandlingStrategy ContentHandling { get; set; } #endregion #region Parameter TargetCredential /// /// /// Specifies whether credentials are required for a put integration. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TargetCredential { get; set; } #endregion #region Parameter HttpMethod /// /// /// Specifies the HTTP method for the integration. /// /// #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 HttpMethod { get; set; } #endregion #region Parameter TlsConfig_InsecureSkipVerification /// /// /// Specifies whether or not API Gateway skips verification that the certificate for an /// integration endpoint is issued by a supported certificate authority. This isn’t recommended, /// but it enables you to use certificates that are signed by private certificate authorities, /// or certificates that are self-signed. If enabled, API Gateway still performs basic /// certificate validation, which includes checking the certificate's expiration date, /// hostname, and presence of a root certificate authority. Supported only for HTTP /// and HTTP_PROXY integrations.Enabling insecureSkipVerification isn't recommended, especially for integrations /// with public HTTPS endpoints. If you enable insecureSkipVerification, /// you increase the risk of man-in-the-middle attacks. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? TlsConfig_InsecureSkipVerification { get; set; } #endregion #region Parameter IntegrationHttpMethod /// /// /// The HTTP method for the integration. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IntegrationHttpMethod { get; set; } #endregion #region Parameter PassthroughBehavior /// /// /// Specifies the pass-through behavior for incoming requests based on the Content-Type /// header in the request, and the available mapping templates specified as the requestTemplates /// property on the Integration resource. There are three valid values: WHEN_NO_MATCH, /// WHEN_NO_TEMPLATES, and NEVER. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PassthroughBehavior { get; set; } #endregion #region Parameter RequestParameter /// /// /// A key-value map specifying request parameters that are passed from the method request /// to the back end. The key is an integration request parameter name and the associated /// value is a method request parameter value or static value that must be enclosed within /// single quotes and pre-encoded as required by the back end. The method request parameter /// value must match the pattern of method.request.{location}.{name}, where /// location is querystring, path, or header /// and name must be a valid and unique method request parameter name. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RequestParameters")] public System.Collections.Hashtable RequestParameter { get; set; } #endregion #region Parameter RequestTemplate /// /// /// Represents a map of Velocity templates that are applied on the request payload based /// on the value of the Content-Type header sent by the client. The content type value /// is the key in this map, and the template (as a String) is the value. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RequestTemplates")] public System.Collections.Hashtable RequestTemplate { get; set; } #endregion #region Parameter ResourceId /// /// /// Specifies a put integration request's resource ID. /// /// #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 ResourceId { get; set; } #endregion #region Parameter RestApiId /// /// /// The string identifier of the associated RestApi. /// /// #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 RestApiId { get; set; } #endregion #region Parameter TimeoutInMilli /// /// /// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds /// or 29 seconds. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TimeoutInMillis")] public System.Int32? TimeoutInMilli { get; set; } #endregion #region Parameter Type /// /// /// Specifies a put integration input's type. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.APIGateway.IntegrationType")] public Amazon.APIGateway.IntegrationType Type { get; set; } #endregion #region Parameter Uri /// /// /// Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP /// or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) /// URL according to the RFC-3986 specification, for either standard integration, where /// connectionType is not VPC_LINK, or private integration, /// where connectionType is VPC_LINK. For a private HTTP integration, /// the URI is not used for routing. For AWS or AWS_PROXY integrations, /// the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. /// Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name /// of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated /// subdomain supported by certain Amazon Web Services service for fast host-name lookup. /// action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... /// query string. The ensuing {service_api} refers to a supported action {name} plus any /// required input parameters. Alternatively, path can be used for an Amazon Web Services /// service path-based API. The ensuing service_api refers to the path to an Amazon Web /// Services service resource, including the region of the integrated Amazon Web Services /// service, if applicable. For example, for integration with the S3 API of GetObject, /// the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} /// or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Uri { 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.APIGateway.Model.PutIntegrationResponse). /// Specifying the name of a property of type Amazon.APIGateway.Model.PutIntegrationResponse 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 RestApiId parameter. /// The -PassThru parameter is deprecated, use -Select '^RestApiId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RestApiId' 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.ResourceId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-AGIntegration (PutIntegration)")) { 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.RestApiId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.CacheKeyParameter != null) { context.CacheKeyParameter = new List(this.CacheKeyParameter); } context.CacheNamespace = this.CacheNamespace; context.ConnectionId = this.ConnectionId; context.ConnectionType = this.ConnectionType; context.ContentHandling = this.ContentHandling; context.TargetCredential = this.TargetCredential; context.HttpMethod = this.HttpMethod; #if MODULAR if (this.HttpMethod == null && ParameterWasBound(nameof(this.HttpMethod))) { WriteWarning("You are passing $null as a value for parameter HttpMethod 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.IntegrationHttpMethod = this.IntegrationHttpMethod; context.PassthroughBehavior = this.PassthroughBehavior; if (this.RequestParameter != null) { context.RequestParameter = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.RequestParameter.Keys) { context.RequestParameter.Add((String)hashKey, (String)(this.RequestParameter[hashKey])); } } if (this.RequestTemplate != null) { context.RequestTemplate = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.RequestTemplate.Keys) { context.RequestTemplate.Add((String)hashKey, (String)(this.RequestTemplate[hashKey])); } } context.ResourceId = this.ResourceId; #if MODULAR if (this.ResourceId == null && ParameterWasBound(nameof(this.ResourceId))) { WriteWarning("You are passing $null as a value for parameter ResourceId 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.RestApiId = this.RestApiId; #if MODULAR if (this.RestApiId == null && ParameterWasBound(nameof(this.RestApiId))) { WriteWarning("You are passing $null as a value for parameter RestApiId 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.TimeoutInMilli = this.TimeoutInMilli; context.TlsConfig_InsecureSkipVerification = this.TlsConfig_InsecureSkipVerification; context.Type = this.Type; #if MODULAR if (this.Type == null && ParameterWasBound(nameof(this.Type))) { WriteWarning("You are passing $null as a value for parameter Type 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.Uri = this.Uri; // 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.APIGateway.Model.PutIntegrationRequest(); if (cmdletContext.CacheKeyParameter != null) { request.CacheKeyParameters = cmdletContext.CacheKeyParameter; } if (cmdletContext.CacheNamespace != null) { request.CacheNamespace = cmdletContext.CacheNamespace; } if (cmdletContext.ConnectionId != null) { request.ConnectionId = cmdletContext.ConnectionId; } if (cmdletContext.ConnectionType != null) { request.ConnectionType = cmdletContext.ConnectionType; } if (cmdletContext.ContentHandling != null) { request.ContentHandling = cmdletContext.ContentHandling; } if (cmdletContext.TargetCredential != null) { request.Credentials = cmdletContext.TargetCredential; } if (cmdletContext.HttpMethod != null) { request.HttpMethod = cmdletContext.HttpMethod; } if (cmdletContext.IntegrationHttpMethod != null) { request.IntegrationHttpMethod = cmdletContext.IntegrationHttpMethod; } if (cmdletContext.PassthroughBehavior != null) { request.PassthroughBehavior = cmdletContext.PassthroughBehavior; } if (cmdletContext.RequestParameter != null) { request.RequestParameters = cmdletContext.RequestParameter; } if (cmdletContext.RequestTemplate != null) { request.RequestTemplates = cmdletContext.RequestTemplate; } if (cmdletContext.ResourceId != null) { request.ResourceId = cmdletContext.ResourceId; } if (cmdletContext.RestApiId != null) { request.RestApiId = cmdletContext.RestApiId; } if (cmdletContext.TimeoutInMilli != null) { request.TimeoutInMillis = cmdletContext.TimeoutInMilli.Value; } // populate TlsConfig var requestTlsConfigIsNull = true; request.TlsConfig = new Amazon.APIGateway.Model.TlsConfig(); System.Boolean? requestTlsConfig_tlsConfig_InsecureSkipVerification = null; if (cmdletContext.TlsConfig_InsecureSkipVerification != null) { requestTlsConfig_tlsConfig_InsecureSkipVerification = cmdletContext.TlsConfig_InsecureSkipVerification.Value; } if (requestTlsConfig_tlsConfig_InsecureSkipVerification != null) { request.TlsConfig.InsecureSkipVerification = requestTlsConfig_tlsConfig_InsecureSkipVerification.Value; requestTlsConfigIsNull = false; } // determine if request.TlsConfig should be set to null if (requestTlsConfigIsNull) { request.TlsConfig = null; } if (cmdletContext.Type != null) { request.Type = cmdletContext.Type; } if (cmdletContext.Uri != null) { request.Uri = cmdletContext.Uri; } 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.APIGateway.Model.PutIntegrationResponse CallAWSServiceOperation(IAmazonAPIGateway client, Amazon.APIGateway.Model.PutIntegrationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway", "PutIntegration"); try { #if DESKTOP return client.PutIntegration(request); #elif CORECLR return client.PutIntegrationAsync(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 List CacheKeyParameter { get; set; } public System.String CacheNamespace { get; set; } public System.String ConnectionId { get; set; } public Amazon.APIGateway.ConnectionType ConnectionType { get; set; } public Amazon.APIGateway.ContentHandlingStrategy ContentHandling { get; set; } public System.String TargetCredential { get; set; } public System.String HttpMethod { get; set; } public System.String IntegrationHttpMethod { get; set; } public System.String PassthroughBehavior { get; set; } public Dictionary RequestParameter { get; set; } public Dictionary RequestTemplate { get; set; } public System.String ResourceId { get; set; } public System.String RestApiId { get; set; } public System.Int32? TimeoutInMilli { get; set; } public System.Boolean? TlsConfig_InsecureSkipVerification { get; set; } public Amazon.APIGateway.IntegrationType Type { get; set; } public System.String Uri { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }