/*******************************************************************************
* 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.WorkMail;
using Amazon.WorkMail.Model;
namespace Amazon.PowerShell.Cmdlets.WM
{
///
/// Adds a new access control rule for the specified organization. The rule allows or
/// denies access to the organization for the specified IPv4 addresses, access protocol
/// actions, user IDs and impersonation IDs. Adding a new rule with the same name as an
/// existing rule replaces the older rule.
///
[Cmdlet("Write", "WMAccessControlRule", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon WorkMail PutAccessControlRule API operation.", Operation = new[] {"PutAccessControlRule"}, SelectReturnType = typeof(Amazon.WorkMail.Model.PutAccessControlRuleResponse))]
[AWSCmdletOutput("None or Amazon.WorkMail.Model.PutAccessControlRuleResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.WorkMail.Model.PutAccessControlRuleResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteWMAccessControlRuleCmdlet : AmazonWorkMailClientCmdlet, IExecutor
{
#region Parameter Action
///
///
/// Access protocol actions to include in the rule. Valid values include ActiveSync
,
/// AutoDiscover
, EWS
, IMAP
, SMTP
,
/// WindowsOutlook
, and WebMail
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Actions")]
public System.String[] Action { get; set; }
#endregion
#region Parameter Description
///
///
/// The rule description.
///
///
#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 Description { get; set; }
#endregion
#region Parameter Effect
///
///
/// The rule effect.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.WorkMail.AccessControlRuleEffect")]
public Amazon.WorkMail.AccessControlRuleEffect Effect { get; set; }
#endregion
#region Parameter ImpersonationRoleId
///
///
/// Impersonation role IDs to include in the rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ImpersonationRoleIds")]
public System.String[] ImpersonationRoleId { get; set; }
#endregion
#region Parameter IpRange
///
///
/// IPv4 CIDR ranges to include in the rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("IpRanges")]
public System.String[] IpRange { get; set; }
#endregion
#region Parameter Name
///
///
/// The rule name.
///
///
#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 Name { get; set; }
#endregion
#region Parameter NotAction
///
///
/// Access protocol actions to exclude from the rule. Valid values include ActiveSync
,
/// AutoDiscover
, EWS
, IMAP
, SMTP
,
/// WindowsOutlook
, and WebMail
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NotActions")]
public System.String[] NotAction { get; set; }
#endregion
#region Parameter NotImpersonationRoleId
///
///
/// Impersonation role IDs to exclude from the rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NotImpersonationRoleIds")]
public System.String[] NotImpersonationRoleId { get; set; }
#endregion
#region Parameter NotIpRange
///
///
/// IPv4 CIDR ranges to exclude from the rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NotIpRanges")]
public System.String[] NotIpRange { get; set; }
#endregion
#region Parameter NotUserId
///
///
/// User IDs to exclude from the rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("NotUserIds")]
public System.String[] NotUserId { get; set; }
#endregion
#region Parameter OrganizationId
///
///
/// The identifier of the organization.
///
///
#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 OrganizationId { get; set; }
#endregion
#region Parameter UserId
///
///
/// User IDs to include in the rule.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("UserIds")]
public System.String[] UserId { 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.WorkMail.Model.PutAccessControlRuleResponse).
/// 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 Name parameter.
/// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-WMAccessControlRule (PutAccessControlRule)"))
{
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.Name;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Action != null)
{
context.Action = new List(this.Action);
}
context.Description = this.Description;
#if MODULAR
if (this.Description == null && ParameterWasBound(nameof(this.Description)))
{
WriteWarning("You are passing $null as a value for parameter Description 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.Effect = this.Effect;
#if MODULAR
if (this.Effect == null && ParameterWasBound(nameof(this.Effect)))
{
WriteWarning("You are passing $null as a value for parameter Effect 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.ImpersonationRoleId != null)
{
context.ImpersonationRoleId = new List(this.ImpersonationRoleId);
}
if (this.IpRange != null)
{
context.IpRange = new List(this.IpRange);
}
context.Name = this.Name;
#if MODULAR
if (this.Name == null && ParameterWasBound(nameof(this.Name)))
{
WriteWarning("You are passing $null as a value for parameter Name 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.NotAction != null)
{
context.NotAction = new List(this.NotAction);
}
if (this.NotImpersonationRoleId != null)
{
context.NotImpersonationRoleId = new List(this.NotImpersonationRoleId);
}
if (this.NotIpRange != null)
{
context.NotIpRange = new List(this.NotIpRange);
}
if (this.NotUserId != null)
{
context.NotUserId = new List(this.NotUserId);
}
context.OrganizationId = this.OrganizationId;
#if MODULAR
if (this.OrganizationId == null && ParameterWasBound(nameof(this.OrganizationId)))
{
WriteWarning("You are passing $null as a value for parameter OrganizationId 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.UserId != null)
{
context.UserId = new List(this.UserId);
}
// 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.WorkMail.Model.PutAccessControlRuleRequest();
if (cmdletContext.Action != null)
{
request.Actions = cmdletContext.Action;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.Effect != null)
{
request.Effect = cmdletContext.Effect;
}
if (cmdletContext.ImpersonationRoleId != null)
{
request.ImpersonationRoleIds = cmdletContext.ImpersonationRoleId;
}
if (cmdletContext.IpRange != null)
{
request.IpRanges = cmdletContext.IpRange;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.NotAction != null)
{
request.NotActions = cmdletContext.NotAction;
}
if (cmdletContext.NotImpersonationRoleId != null)
{
request.NotImpersonationRoleIds = cmdletContext.NotImpersonationRoleId;
}
if (cmdletContext.NotIpRange != null)
{
request.NotIpRanges = cmdletContext.NotIpRange;
}
if (cmdletContext.NotUserId != null)
{
request.NotUserIds = cmdletContext.NotUserId;
}
if (cmdletContext.OrganizationId != null)
{
request.OrganizationId = cmdletContext.OrganizationId;
}
if (cmdletContext.UserId != null)
{
request.UserIds = cmdletContext.UserId;
}
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.WorkMail.Model.PutAccessControlRuleResponse CallAWSServiceOperation(IAmazonWorkMail client, Amazon.WorkMail.Model.PutAccessControlRuleRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkMail", "PutAccessControlRule");
try
{
#if DESKTOP
return client.PutAccessControlRule(request);
#elif CORECLR
return client.PutAccessControlRuleAsync(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 Action { get; set; }
public System.String Description { get; set; }
public Amazon.WorkMail.AccessControlRuleEffect Effect { get; set; }
public List ImpersonationRoleId { get; set; }
public List IpRange { get; set; }
public System.String Name { get; set; }
public List NotAction { get; set; }
public List NotImpersonationRoleId { get; set; }
public List NotIpRange { get; set; }
public List NotUserId { get; set; }
public System.String OrganizationId { get; set; }
public List UserId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}