/*******************************************************************************
* 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.WAF;
using Amazon.WAF.Model;
namespace Amazon.PowerShell.Cmdlets.WAF
{
/// <summary>
/// <note><para>
/// This is <b>AWS WAF Classic</b> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
/// WAF Classic</a> in the developer guide.
/// </para><para><b>For the latest version of AWS WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS
/// WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints
/// for regional and global use.
/// </para></note><para>
/// Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each
/// <code>IPSetDescriptor</code> object, you specify the following values:
/// </para><ul><li><para>
/// Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code>
/// object, you delete the existing object and add a new one.
/// </para></li><li><para>
/// The IP address version, <code>IPv4</code> or <code>IPv6</code>.
/// </para></li><li><para>
/// The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range
/// of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code>
/// (for the individual IP address <code>192.0.2.44</code>).
/// </para></li></ul><para>
/// AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS
/// WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information
/// about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless
/// Inter-Domain Routing</a>.
/// </para><para>
/// IPv6 addresses can be represented using any of the following formats:
/// </para><ul><li><para>
/// 1111:0000:0000:0000:0000:0000:0000:0111/128
/// </para></li><li><para>
/// 1111:0:0:0:0:0:0:0111/128
/// </para></li><li><para>
/// 1111::0111/128
/// </para></li><li><para>
/// 1111::111/128
/// </para></li></ul><para>
/// You use an <code>IPSet</code> to specify which web requests you want to allow or block
/// based on the IP addresses that the requests originated from. For example, if you're
/// receiving a lot of requests from one or a small number of IP addresses and you want
/// to block the requests, you can create an <code>IPSet</code> that specifies those IP
/// addresses, and then configure AWS WAF to block the requests.
/// </para><para>
/// To create and configure an <code>IPSet</code>, perform the following steps:
/// </para><ol><li><para>
/// Submit a <a>CreateIPSet</a> request.
/// </para></li><li><para>
/// Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code>
/// parameter of an <a>UpdateIPSet</a> request.
/// </para></li><li><para>
/// Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want
/// AWS WAF to watch for.
/// </para></li></ol><para>
/// When you update an <code>IPSet</code>, you specify the IP addresses that you want
/// to add and/or the IP addresses that you want to delete. If you want to change an IP
/// address, you delete the existing IP address and add the new one.
/// </para><para>
/// You can insert a maximum of 1000 addresses in a single request.
/// </para><para>
/// For more information about how to use the AWS WAF API to allow or block HTTP requests,
/// see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer
/// Guide</a>.
/// </para>
/// </summary>
[Cmdlet("Update", "WAFIPSet", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS WAF UpdateIPSet API operation.", Operation = new[] {"UpdateIPSet"}, SelectReturnType = typeof(Amazon.WAF.Model.UpdateIPSetResponse))]
[AWSCmdletOutput("System.String or Amazon.WAF.Model.UpdateIPSetResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.WAF.Model.UpdateIPSetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateWAFIPSetCmdlet : AmazonWAFClientCmdlet, IExecutor
{
#region Parameter ChangeToken
/// <summary>
/// <para>
/// <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para>
/// </para>
/// </summary>
#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 ChangeToken { get; set; }
#endregion
#region Parameter IPSetId
/// <summary>
/// <para>
/// <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code>
/// is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para>
/// </para>
/// </summary>
#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 IPSetId { get; set; }
#endregion
#region Parameter Update
/// <summary>
/// <para>
/// <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete
/// from an <a>IPSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code></para></li><li><para><a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code></para></li></ul><para>You can insert a maximum of 1000 addresses in a single request.</para>
/// </para>
/// </summary>
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("Updates")]
public Amazon.WAF.Model.IPSetUpdate[] Update { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'ChangeToken'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAF.Model.UpdateIPSetResponse).
/// Specifying the name of a property of type Amazon.WAF.Model.UpdateIPSetResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "ChangeToken";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the IPSetId parameter.
/// The -PassThru parameter is deprecated, use -Select '^IPSetId' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IPSetId' 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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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.IPSetId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-WAFIPSet (UpdateIPSet)"))
{
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<Amazon.WAF.Model.UpdateIPSetResponse, UpdateWAFIPSetCmdlet>(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.IPSetId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ChangeToken = this.ChangeToken;
#if MODULAR
if (this.ChangeToken == null && ParameterWasBound(nameof(this.ChangeToken)))
{
WriteWarning("You are passing $null as a value for parameter ChangeToken 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.IPSetId = this.IPSetId;
#if MODULAR
if (this.IPSetId == null && ParameterWasBound(nameof(this.IPSetId)))
{
WriteWarning("You are passing $null as a value for parameter IPSetId 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
if (this.Update != null)
{
context.Update = new List<Amazon.WAF.Model.IPSetUpdate>(this.Update);
}
#if MODULAR
if (this.Update == null && ParameterWasBound(nameof(this.Update)))
{
WriteWarning("You are passing $null as a value for parameter Update 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.WAF.Model.UpdateIPSetRequest();
if (cmdletContext.ChangeToken != null)
{
request.ChangeToken = cmdletContext.ChangeToken;
}
if (cmdletContext.IPSetId != null)
{
request.IPSetId = cmdletContext.IPSetId;
}
if (cmdletContext.Update != null)
{
request.Updates = cmdletContext.Update;
}
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.WAF.Model.UpdateIPSetResponse CallAWSServiceOperation(IAmazonWAF client, Amazon.WAF.Model.UpdateIPSetRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF", "UpdateIPSet");
try
{
#if DESKTOP
return client.UpdateIPSet(request);
#elif CORECLR
return client.UpdateIPSetAsync(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 ChangeToken { get; set; }
public System.String IPSetId { get; set; }
public List<Amazon.WAF.Model.IPSetUpdate> Update { get; set; }
public System.Func<Amazon.WAF.Model.UpdateIPSetResponse, UpdateWAFIPSetCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.ChangeToken;
}
}
}