/*******************************************************************************
* 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.SecurityHub;
using Amazon.SecurityHub.Model;
namespace Amazon.PowerShell.Cmdlets.SHUB
{
///
/// Updates configuration options for Security Hub.
///
[Cmdlet("Update", "SHUBSecurityHubConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the AWS Security Hub UpdateSecurityHubConfiguration API operation.", Operation = new[] {"UpdateSecurityHubConfiguration"}, SelectReturnType = typeof(Amazon.SecurityHub.Model.UpdateSecurityHubConfigurationResponse))]
[AWSCmdletOutput("None or Amazon.SecurityHub.Model.UpdateSecurityHubConfigurationResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.SecurityHub.Model.UpdateSecurityHubConfigurationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateSHUBSecurityHubConfigurationCmdlet : AmazonSecurityHubClientCmdlet, IExecutor
{
#region Parameter AutoEnableControl
///
///
/// Whether to automatically enable new controls when they are added to standards that
/// are enabled.By default, this is set to true
, and new controls are enabled automatically.
/// To not automatically enable new controls, set this to false
.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
[Alias("AutoEnableControls")]
public System.Boolean? AutoEnableControl { get; set; }
#endregion
#region Parameter ControlFindingGenerator
///
///
/// Updates whether the calling account has consolidated control findings turned on. If
/// the value for this field is set to SECURITY_CONTROL
, Security Hub generates
/// a single finding for a control check even when the check applies to multiple enabled
/// standards.If the value for this field is set to STANDARD_CONTROL
, Security Hub
/// generates separate findings for a control check when the check applies to multiple
/// enabled standards.For accounts that are part of an organization, this value can only be updated in the
/// administrator account.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SecurityHub.ControlFindingGenerator")]
public Amazon.SecurityHub.ControlFindingGenerator ControlFindingGenerator { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityHub.Model.UpdateSecurityHubConfigurationResponse).
/// 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 AutoEnableControl parameter.
/// The -PassThru parameter is deprecated, use -Select '^AutoEnableControl' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AutoEnableControl' 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.AutoEnableControl), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-SHUBSecurityHubConfiguration (UpdateSecurityHubConfiguration)"))
{
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.AutoEnableControl;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AutoEnableControl = this.AutoEnableControl;
context.ControlFindingGenerator = this.ControlFindingGenerator;
// 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.SecurityHub.Model.UpdateSecurityHubConfigurationRequest();
if (cmdletContext.AutoEnableControl != null)
{
request.AutoEnableControls = cmdletContext.AutoEnableControl.Value;
}
if (cmdletContext.ControlFindingGenerator != null)
{
request.ControlFindingGenerator = cmdletContext.ControlFindingGenerator;
}
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.SecurityHub.Model.UpdateSecurityHubConfigurationResponse CallAWSServiceOperation(IAmazonSecurityHub client, Amazon.SecurityHub.Model.UpdateSecurityHubConfigurationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Security Hub", "UpdateSecurityHubConfiguration");
try
{
#if DESKTOP
return client.UpdateSecurityHubConfiguration(request);
#elif CORECLR
return client.UpdateSecurityHubConfigurationAsync(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.Boolean? AutoEnableControl { get; set; }
public Amazon.SecurityHub.ControlFindingGenerator ControlFindingGenerator { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}