/*******************************************************************************
* 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
{
/// <summary>
/// A complex type that contains settings for encryption of your firewall resources.
/// </summary>
[Cmdlet("Update", "NWFWFirewallEncryptionConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse")]
[AWSCmdlet("Calls the AWS Network Firewall UpdateFirewallEncryptionConfiguration API operation.", Operation = new[] {"UpdateFirewallEncryptionConfiguration"}, SelectReturnType = typeof(Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse))]
[AWSCmdletOutput("Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse",
"This cmdlet returns an Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateNWFWFirewallEncryptionConfigurationCmdlet : AmazonNetworkFirewallClientCmdlet, IExecutor
{
#region Parameter FirewallArn
/// <summary>
/// <para>
/// <para>The Amazon Resource Name (ARN) of the firewall.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String FirewallArn { get; set; }
#endregion
#region Parameter FirewallName
/// <summary>
/// <para>
/// <para>The descriptive name of the firewall. You can't change the name of a firewall after
/// you create it.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FirewallName { get; set; }
#endregion
#region Parameter EncryptionConfiguration_KeyId
/// <summary>
/// <para>
/// <para>The ID of the Amazon Web Services Key Management Service (KMS) customer managed key.
/// You can use any of the key identifiers that KMS supports, unless you're using a key
/// that's managed by another account. If you're using a key managed by another account,
/// then specify the key ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key
/// ID</a> in the <i>Amazon Web Services KMS Developer Guide</i>.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EncryptionConfiguration_KeyId { get; set; }
#endregion
#region Parameter EncryptionConfiguration_Type
/// <summary>
/// <para>
/// <para>The type of Amazon Web Services KMS key to use for encryption of your Network Firewall
/// resources.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.NetworkFirewall.EncryptionType")]
public Amazon.NetworkFirewall.EncryptionType EncryptionConfiguration_Type { get; set; }
#endregion
#region Parameter UpdateToken
/// <summary>
/// <para>
/// <para>An optional token that you can use for optimistic locking. Network Firewall returns
/// a token to your requests that access the firewall. The token marks the state of the
/// firewall resource at the time of the request. </para><para>To make an unconditional change to the firewall, omit the token in your update request.
/// Without the token, Network Firewall performs your updates regardless of whether the
/// firewall has changed since you last retrieved it.</para><para>To make a conditional change to the firewall, provide the token in your update request.
/// Network Firewall uses the token to ensure that the firewall hasn't changed since you
/// last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>.
/// If this happens, retrieve the firewall again to get a current copy of it with a new
/// token. Reapply your changes as needed, then try the operation again using the new
/// token. </para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String UpdateToken { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// 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.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse).
/// Specifying the name of a property of type Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse 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; } = "*";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the FirewallArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^FirewallArn' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FirewallArn' 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.FirewallArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-NWFWFirewallEncryptionConfiguration (UpdateFirewallEncryptionConfiguration)"))
{
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.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse, UpdateNWFWFirewallEncryptionConfigurationCmdlet>(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.FirewallArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.EncryptionConfiguration_KeyId = this.EncryptionConfiguration_KeyId;
context.EncryptionConfiguration_Type = this.EncryptionConfiguration_Type;
context.FirewallArn = this.FirewallArn;
context.FirewallName = this.FirewallName;
context.UpdateToken = this.UpdateToken;
// 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.UpdateFirewallEncryptionConfigurationRequest();
// populate EncryptionConfiguration
var requestEncryptionConfigurationIsNull = true;
request.EncryptionConfiguration = new Amazon.NetworkFirewall.Model.EncryptionConfiguration();
System.String requestEncryptionConfiguration_encryptionConfiguration_KeyId = null;
if (cmdletContext.EncryptionConfiguration_KeyId != null)
{
requestEncryptionConfiguration_encryptionConfiguration_KeyId = cmdletContext.EncryptionConfiguration_KeyId;
}
if (requestEncryptionConfiguration_encryptionConfiguration_KeyId != null)
{
request.EncryptionConfiguration.KeyId = requestEncryptionConfiguration_encryptionConfiguration_KeyId;
requestEncryptionConfigurationIsNull = false;
}
Amazon.NetworkFirewall.EncryptionType requestEncryptionConfiguration_encryptionConfiguration_Type = null;
if (cmdletContext.EncryptionConfiguration_Type != null)
{
requestEncryptionConfiguration_encryptionConfiguration_Type = cmdletContext.EncryptionConfiguration_Type;
}
if (requestEncryptionConfiguration_encryptionConfiguration_Type != null)
{
request.EncryptionConfiguration.Type = requestEncryptionConfiguration_encryptionConfiguration_Type;
requestEncryptionConfigurationIsNull = false;
}
// determine if request.EncryptionConfiguration should be set to null
if (requestEncryptionConfigurationIsNull)
{
request.EncryptionConfiguration = null;
}
if (cmdletContext.FirewallArn != null)
{
request.FirewallArn = cmdletContext.FirewallArn;
}
if (cmdletContext.FirewallName != null)
{
request.FirewallName = cmdletContext.FirewallName;
}
if (cmdletContext.UpdateToken != null)
{
request.UpdateToken = cmdletContext.UpdateToken;
}
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.UpdateFirewallEncryptionConfigurationResponse CallAWSServiceOperation(IAmazonNetworkFirewall client, Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Network Firewall", "UpdateFirewallEncryptionConfiguration");
try
{
#if DESKTOP
return client.UpdateFirewallEncryptionConfiguration(request);
#elif CORECLR
return client.UpdateFirewallEncryptionConfigurationAsync(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 EncryptionConfiguration_KeyId { get; set; }
public Amazon.NetworkFirewall.EncryptionType EncryptionConfiguration_Type { get; set; }
public System.String FirewallArn { get; set; }
public System.String FirewallName { get; set; }
public System.String UpdateToken { get; set; }
public System.Func<Amazon.NetworkFirewall.Model.UpdateFirewallEncryptionConfigurationResponse, UpdateNWFWFirewallEncryptionConfigurationCmdlet, object> Select { get; set; } =
(response, cmdlet) => response;
}
}
}