/*******************************************************************************
* 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
{
///
///
/// This is AWS WAF Classic documentation. For more information, see AWS
/// WAF Classic in the developer guide.
/// For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
/// WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints
/// for regional and global use.
///
/// Associates a LoggingConfiguration with a specified web ACL.
///
/// You can access information about all traffic that AWS WAF inspects using the following
/// steps:
/// -
/// Create an Amazon Kinesis Data Firehose.
///
/// Create the data firehose with a PUT source and in the region that you are operating.
/// However, if you are capturing logs for Amazon CloudFront, always create the firehose
/// in US East (N. Virginia).
///
/// Do not create the data firehose using a
Kinesis stream
as your source.
/// -
/// Associate that firehose to your web ACL using a
PutLoggingConfiguration
/// request.
///
/// When you successfully enable logging using a PutLoggingConfiguration
/// request, AWS WAF will create a service linked role with the necessary permissions
/// to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging
/// Web ACL Traffic Information in the AWS WAF Developer Guide.
///
///
[Cmdlet("Write", "WAFLoggingConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.WAF.Model.LoggingConfiguration")]
[AWSCmdlet("Calls the AWS WAF PutLoggingConfiguration API operation.", Operation = new[] {"PutLoggingConfiguration"}, SelectReturnType = typeof(Amazon.WAF.Model.PutLoggingConfigurationResponse))]
[AWSCmdletOutput("Amazon.WAF.Model.LoggingConfiguration or Amazon.WAF.Model.PutLoggingConfigurationResponse",
"This cmdlet returns an Amazon.WAF.Model.LoggingConfiguration object.",
"The service call response (type Amazon.WAF.Model.PutLoggingConfigurationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteWAFLoggingConfigurationCmdlet : AmazonWAFClientCmdlet, IExecutor
{
#region Parameter LoggingConfiguration_LogDestinationConfig
///
///
/// An array of Amazon Kinesis Data Firehose ARNs.
///
///
#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("LoggingConfiguration_LogDestinationConfigs")]
public System.String[] LoggingConfiguration_LogDestinationConfig { get; set; }
#endregion
#region Parameter LoggingConfiguration_RedactedField
///
///
/// The parts of the request that you want redacted from the logs. For example, if you
/// redact the cookie field, the cookie field in the firehose will be xxx
.
///
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("LoggingConfiguration_RedactedFields")]
public Amazon.WAF.Model.FieldToMatch[] LoggingConfiguration_RedactedField { get; set; }
#endregion
#region Parameter LoggingConfiguration_ResourceArn
///
///
/// The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
///
///
#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 LoggingConfiguration_ResourceArn { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'LoggingConfiguration'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAF.Model.PutLoggingConfigurationResponse).
/// Specifying the name of a property of type Amazon.WAF.Model.PutLoggingConfigurationResponse 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; } = "LoggingConfiguration";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the LoggingConfiguration_ResourceArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^LoggingConfiguration_ResourceArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^LoggingConfiguration_ResourceArn' 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.LoggingConfiguration_ResourceArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-WAFLoggingConfiguration (PutLoggingConfiguration)"))
{
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.LoggingConfiguration_ResourceArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.LoggingConfiguration_LogDestinationConfig != null)
{
context.LoggingConfiguration_LogDestinationConfig = new List(this.LoggingConfiguration_LogDestinationConfig);
}
#if MODULAR
if (this.LoggingConfiguration_LogDestinationConfig == null && ParameterWasBound(nameof(this.LoggingConfiguration_LogDestinationConfig)))
{
WriteWarning("You are passing $null as a value for parameter LoggingConfiguration_LogDestinationConfig 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.LoggingConfiguration_RedactedField != null)
{
context.LoggingConfiguration_RedactedField = new List(this.LoggingConfiguration_RedactedField);
}
context.LoggingConfiguration_ResourceArn = this.LoggingConfiguration_ResourceArn;
#if MODULAR
if (this.LoggingConfiguration_ResourceArn == null && ParameterWasBound(nameof(this.LoggingConfiguration_ResourceArn)))
{
WriteWarning("You are passing $null as a value for parameter LoggingConfiguration_ResourceArn 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.PutLoggingConfigurationRequest();
// populate LoggingConfiguration
var requestLoggingConfigurationIsNull = true;
request.LoggingConfiguration = new Amazon.WAF.Model.LoggingConfiguration();
List requestLoggingConfiguration_loggingConfiguration_LogDestinationConfig = null;
if (cmdletContext.LoggingConfiguration_LogDestinationConfig != null)
{
requestLoggingConfiguration_loggingConfiguration_LogDestinationConfig = cmdletContext.LoggingConfiguration_LogDestinationConfig;
}
if (requestLoggingConfiguration_loggingConfiguration_LogDestinationConfig != null)
{
request.LoggingConfiguration.LogDestinationConfigs = requestLoggingConfiguration_loggingConfiguration_LogDestinationConfig;
requestLoggingConfigurationIsNull = false;
}
List requestLoggingConfiguration_loggingConfiguration_RedactedField = null;
if (cmdletContext.LoggingConfiguration_RedactedField != null)
{
requestLoggingConfiguration_loggingConfiguration_RedactedField = cmdletContext.LoggingConfiguration_RedactedField;
}
if (requestLoggingConfiguration_loggingConfiguration_RedactedField != null)
{
request.LoggingConfiguration.RedactedFields = requestLoggingConfiguration_loggingConfiguration_RedactedField;
requestLoggingConfigurationIsNull = false;
}
System.String requestLoggingConfiguration_loggingConfiguration_ResourceArn = null;
if (cmdletContext.LoggingConfiguration_ResourceArn != null)
{
requestLoggingConfiguration_loggingConfiguration_ResourceArn = cmdletContext.LoggingConfiguration_ResourceArn;
}
if (requestLoggingConfiguration_loggingConfiguration_ResourceArn != null)
{
request.LoggingConfiguration.ResourceArn = requestLoggingConfiguration_loggingConfiguration_ResourceArn;
requestLoggingConfigurationIsNull = false;
}
// determine if request.LoggingConfiguration should be set to null
if (requestLoggingConfigurationIsNull)
{
request.LoggingConfiguration = null;
}
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.PutLoggingConfigurationResponse CallAWSServiceOperation(IAmazonWAF client, Amazon.WAF.Model.PutLoggingConfigurationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF", "PutLoggingConfiguration");
try
{
#if DESKTOP
return client.PutLoggingConfiguration(request);
#elif CORECLR
return client.PutLoggingConfigurationAsync(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 LoggingConfiguration_LogDestinationConfig { get; set; }
public List LoggingConfiguration_RedactedField { get; set; }
public System.String LoggingConfiguration_ResourceArn { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.LoggingConfiguration;
}
}
}