/*******************************************************************************
* 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.FinSpaceData;
using Amazon.FinSpaceData.Model;
namespace Amazon.PowerShell.Cmdlets.FNSP
{
///
/// Creates a new user in FinSpace.
///
[Cmdlet("New", "FNSPUser", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the FinSpace Public API CreateUser API operation.", Operation = new[] {"CreateUser"}, SelectReturnType = typeof(Amazon.FinSpaceData.Model.CreateUserResponse))]
[AWSCmdletOutput("System.String or Amazon.FinSpaceData.Model.CreateUserResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.FinSpaceData.Model.CreateUserResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewFNSPUserCmdlet : AmazonFinSpaceDataClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter ApiAccess
///
///
/// The option to indicate whether the user can use the GetProgrammaticAccessCredentials
/// API to obtain credentials that can then be used to access other FinSpace Data API
/// operations.ENABLED
– The user has permissions to use the APIs.DISABLED
– The user does not have permissions to use any APIs.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.FinSpaceData.ApiAccess")]
public Amazon.FinSpaceData.ApiAccess ApiAccess { get; set; }
#endregion
#region Parameter ApiAccessPrincipalArn
///
///
/// The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
/// API to obtain a credentials token for a specific FinSpace user. This must be an IAM
/// role within your FinSpace account.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ApiAccessPrincipalArn { get; set; }
#endregion
#region Parameter EmailAddress
///
///
/// The email address of the user that you want to register. The email address serves
/// as a uniquer identifier for each user and cannot be changed after it's created.
///
///
#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 EmailAddress { get; set; }
#endregion
#region Parameter FirstName
///
///
/// The first name of the user that you want to register.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FirstName { get; set; }
#endregion
#region Parameter LastName
///
///
/// The last name of the user that you want to register.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LastName { get; set; }
#endregion
#region Parameter Type
///
///
/// The option to indicate the type of user. Use one of the following options to specify
/// this parameter:SUPER_USER
– A user with permission to all the functionality and data
/// in FinSpace.APP_USER
– A user with specific permissions in FinSpace. The users are
/// assigned permissions by adding them to a permission group.
///
///
#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.FinSpaceData.UserType")]
public Amazon.FinSpaceData.UserType Type { get; set; }
#endregion
#region Parameter ClientToken
///
///
/// A token that ensures idempotency. This token expires in 10 minutes.
///
///
[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 'UserId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FinSpaceData.Model.CreateUserResponse).
/// Specifying the name of a property of type Amazon.FinSpaceData.Model.CreateUserResponse 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; } = "UserId";
#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 = string.Empty;
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-FNSPUser (CreateUser)"))
{
return;
}
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.ApiAccess = this.ApiAccess;
context.ApiAccessPrincipalArn = this.ApiAccessPrincipalArn;
context.ClientToken = this.ClientToken;
context.EmailAddress = this.EmailAddress;
#if MODULAR
if (this.EmailAddress == null && ParameterWasBound(nameof(this.EmailAddress)))
{
WriteWarning("You are passing $null as a value for parameter EmailAddress 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.FirstName = this.FirstName;
context.LastName = this.LastName;
context.Type = this.Type;
#if MODULAR
if (this.Type == null && ParameterWasBound(nameof(this.Type)))
{
WriteWarning("You are passing $null as a value for parameter Type 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
// 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.FinSpaceData.Model.CreateUserRequest();
if (cmdletContext.ApiAccess != null)
{
request.ApiAccess = cmdletContext.ApiAccess;
}
if (cmdletContext.ApiAccessPrincipalArn != null)
{
request.ApiAccessPrincipalArn = cmdletContext.ApiAccessPrincipalArn;
}
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.EmailAddress != null)
{
request.EmailAddress = cmdletContext.EmailAddress;
}
if (cmdletContext.FirstName != null)
{
request.FirstName = cmdletContext.FirstName;
}
if (cmdletContext.LastName != null)
{
request.LastName = cmdletContext.LastName;
}
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.FinSpaceData.Model.CreateUserResponse CallAWSServiceOperation(IAmazonFinSpaceData client, Amazon.FinSpaceData.Model.CreateUserRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "FinSpace Public API", "CreateUser");
try
{
#if DESKTOP
return client.CreateUser(request);
#elif CORECLR
return client.CreateUserAsync(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.FinSpaceData.ApiAccess ApiAccess { get; set; }
public System.String ApiAccessPrincipalArn { get; set; }
public System.String ClientToken { get; set; }
public System.String EmailAddress { get; set; }
public System.String FirstName { get; set; }
public System.String LastName { get; set; }
public Amazon.FinSpaceData.UserType Type { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.UserId;
}
}
}