/*******************************************************************************
* 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.NetworkFirewall;
using Amazon.NetworkFirewall.Model;
namespace Amazon.PowerShell.Cmdlets.NWFW
{
///
/// Retrieves the metadata for the rule groups that you have defined. Depending on your
/// setting for max results and the number of rule groups, a single call might not return
/// the full list.
///
[Cmdlet("Get", "NWFWRuleGroupList")]
[OutputType("Amazon.NetworkFirewall.Model.RuleGroupMetadata")]
[AWSCmdlet("Calls the AWS Network Firewall ListRuleGroups API operation.", Operation = new[] {"ListRuleGroups"}, SelectReturnType = typeof(Amazon.NetworkFirewall.Model.ListRuleGroupsResponse))]
[AWSCmdletOutput("Amazon.NetworkFirewall.Model.RuleGroupMetadata or Amazon.NetworkFirewall.Model.ListRuleGroupsResponse",
"This cmdlet returns a collection of Amazon.NetworkFirewall.Model.RuleGroupMetadata objects.",
"The service call response (type Amazon.NetworkFirewall.Model.ListRuleGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetNWFWRuleGroupListCmdlet : AmazonNetworkFirewallClientCmdlet, IExecutor
{
#region Parameter ManagedType
///
///
/// Indicates the general category of the Amazon Web Services managed rule group.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.NetworkFirewall.ResourceManagedType")]
public Amazon.NetworkFirewall.ResourceManagedType ManagedType { get; set; }
#endregion
#region Parameter Scope
///
///
/// The scope of the request. The default setting of ACCOUNT or a setting
/// of NULL returns all of the rule groups in your account. A setting of
/// MANAGED returns all available managed rule groups.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.NetworkFirewall.ResourceManagedStatus")]
public Amazon.NetworkFirewall.ResourceManagedStatus Scope { get; set; }
#endregion
#region Parameter Type
///
///
/// Indicates whether the rule group is stateless or stateful. If the rule group is stateless,
/// it contains stateless rules. If it is stateful, it contains stateful rules.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.NetworkFirewall.RuleGroupType")]
public Amazon.NetworkFirewall.RuleGroupType Type { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of objects that you want Network Firewall to return for this request.
/// If more objects are available, in the response, Network Firewall provides a NextToken
/// value that you can use in a subsequent call to get the next batch of objects.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// When you request a list of objects with a MaxResults setting, if the
/// number of objects that are still available for retrieval exceeds the maximum you requested,
/// Network Firewall returns a NextToken value in the response. To retrieve
/// the next batch of objects, use the token returned from the prior request in your next
/// request.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'RuleGroups'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NetworkFirewall.Model.ListRuleGroupsResponse).
/// Specifying the name of a property of type Amazon.NetworkFirewall.Model.ListRuleGroupsResponse 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; } = "RuleGroups";
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.ManagedType = this.ManagedType;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.Scope = this.Scope;
context.Type = this.Type;
// 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.NetworkFirewall.Model.ListRuleGroupsRequest();
if (cmdletContext.ManagedType != null)
{
request.ManagedType = cmdletContext.ManagedType;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
if (cmdletContext.Scope != null)
{
request.Scope = cmdletContext.Scope;
}
if (cmdletContext.Type != null)
{
request.Type = cmdletContext.Type;
}
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.NetworkFirewall.Model.ListRuleGroupsResponse CallAWSServiceOperation(IAmazonNetworkFirewall client, Amazon.NetworkFirewall.Model.ListRuleGroupsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Network Firewall", "ListRuleGroups");
try
{
#if DESKTOP
return client.ListRuleGroups(request);
#elif CORECLR
return client.ListRuleGroupsAsync(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.NetworkFirewall.ResourceManagedType ManagedType { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public Amazon.NetworkFirewall.ResourceManagedStatus Scope { get; set; }
public Amazon.NetworkFirewall.RuleGroupType Type { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.RuleGroups;
}
}
}