/*******************************************************************************
* 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.WorkSpacesWeb;
using Amazon.WorkSpacesWeb.Model;
namespace Amazon.PowerShell.Cmdlets.WSW
{
///
/// Creates an IP access settings resource that can be associated with a web portal.
///
[Cmdlet("New", "WSWIpAccessSetting", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon WorkSpaces Web CreateIpAccessSettings API operation.", Operation = new[] {"CreateIpAccessSettings"}, SelectReturnType = typeof(Amazon.WorkSpacesWeb.Model.CreateIpAccessSettingsResponse))]
[AWSCmdletOutput("System.String or Amazon.WorkSpacesWeb.Model.CreateIpAccessSettingsResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.WorkSpacesWeb.Model.CreateIpAccessSettingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewWSWIpAccessSettingCmdlet : AmazonWorkSpacesWebClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter AdditionalEncryptionContext
///
///
/// Additional encryption context of the IP access settings.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Collections.Hashtable AdditionalEncryptionContext { get; set; }
#endregion
#region Parameter CustomerManagedKey
///
///
/// The custom managed key of the IP access settings.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String CustomerManagedKey { get; set; }
#endregion
#region Parameter Description
///
///
/// The description of the IP access settings.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter DisplayName
///
///
/// The display name of the IP access settings.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DisplayName { get; set; }
#endregion
#region Parameter IpRule
///
///
/// The IP rules of the IP access settings.
///
///
#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("IpRules")]
public Amazon.WorkSpacesWeb.Model.IpRule[] IpRule { get; set; }
#endregion
#region Parameter Tag
///
///
/// The tags to add to the browser settings resource. A tag is a key-value pair.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.WorkSpacesWeb.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter ClientToken
///
///
/// A unique, case-sensitive identifier that you provide to ensure the idempotency of
/// the request. Idempotency ensures that an API request completes only once. With an
/// idempotent request, if the original request completes successfully, subsequent retries
/// with the same client token returns the result from the original successful request.
/// If you do not specify a client token, one is automatically generated by the AWS SDK.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'IpAccessSettingsArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesWeb.Model.CreateIpAccessSettingsResponse).
/// Specifying the name of a property of type Amazon.WorkSpacesWeb.Model.CreateIpAccessSettingsResponse 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; } = "IpAccessSettingsArn";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the CustomerManagedKey parameter.
/// The -PassThru parameter is deprecated, use -Select '^CustomerManagedKey' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CustomerManagedKey' 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.CustomerManagedKey), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-WSWIpAccessSetting (CreateIpAccessSettings)"))
{
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.CustomerManagedKey;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AdditionalEncryptionContext != null)
{
context.AdditionalEncryptionContext = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.AdditionalEncryptionContext.Keys)
{
context.AdditionalEncryptionContext.Add((String)hashKey, (String)(this.AdditionalEncryptionContext[hashKey]));
}
}
context.ClientToken = this.ClientToken;
context.CustomerManagedKey = this.CustomerManagedKey;
context.Description = this.Description;
context.DisplayName = this.DisplayName;
if (this.IpRule != null)
{
context.IpRule = new List(this.IpRule);
}
#if MODULAR
if (this.IpRule == null && ParameterWasBound(nameof(this.IpRule)))
{
WriteWarning("You are passing $null as a value for parameter IpRule 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.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.WorkSpacesWeb.Model.CreateIpAccessSettingsRequest();
if (cmdletContext.AdditionalEncryptionContext != null)
{
request.AdditionalEncryptionContext = cmdletContext.AdditionalEncryptionContext;
}
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.CustomerManagedKey != null)
{
request.CustomerManagedKey = cmdletContext.CustomerManagedKey;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.DisplayName != null)
{
request.DisplayName = cmdletContext.DisplayName;
}
if (cmdletContext.IpRule != null)
{
request.IpRules = cmdletContext.IpRule;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.WorkSpacesWeb.Model.CreateIpAccessSettingsResponse CallAWSServiceOperation(IAmazonWorkSpacesWeb client, Amazon.WorkSpacesWeb.Model.CreateIpAccessSettingsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces Web", "CreateIpAccessSettings");
try
{
#if DESKTOP
return client.CreateIpAccessSettings(request);
#elif CORECLR
return client.CreateIpAccessSettingsAsync(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 Dictionary AdditionalEncryptionContext { get; set; }
public System.String ClientToken { get; set; }
public System.String CustomerManagedKey { get; set; }
public System.String Description { get; set; }
public System.String DisplayName { get; set; }
public List IpRule { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.IpAccessSettingsArn;
}
}
}