/*******************************************************************************
* 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.AppStream;
using Amazon.AppStream.Model;
namespace Amazon.PowerShell.Cmdlets.APS
{
///
/// Creates a new user in the user pool.
///
[Cmdlet("New", "APSUser", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon AppStream CreateUser API operation.", Operation = new[] {"CreateUser"}, SelectReturnType = typeof(Amazon.AppStream.Model.CreateUserResponse))]
[AWSCmdletOutput("None or Amazon.AppStream.Model.CreateUserResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.AppStream.Model.CreateUserResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewAPSUserCmdlet : AmazonAppStreamClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter AuthenticationType
///
///
/// The authentication type for the user. You must specify USERPOOL.
///
///
#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.AppStream.AuthenticationType")]
public Amazon.AppStream.AuthenticationType AuthenticationType { get; set; }
#endregion
#region Parameter FirstName
///
///
/// The first name, or given name, of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FirstName { get; set; }
#endregion
#region Parameter LastName
///
///
/// The last name, or surname, of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LastName { get; set; }
#endregion
#region Parameter MessageAction
///
///
/// The action to take for the welcome email that is sent to a user after the user is
/// created in the user pool. If you specify SUPPRESS, no email is sent. If you specify
/// RESEND, do not specify the first name or last name of the user. If the value is null,
/// the email is sent. The temporary password in the welcome email is valid for only 7 days. If users don’t
/// set their passwords within 7 days, you must send them a new welcome email.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.AppStream.MessageAction")]
public Amazon.AppStream.MessageAction MessageAction { get; set; }
#endregion
#region Parameter UserName
///
///
/// The email address of the user.Users' email addresses are case-sensitive. During login, if they specify an email
/// address that doesn't use the same capitalization as the email address specified when
/// their user pool account was created, a "user does not exist" error message displays.
///
///
#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 UserName { 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.AppStream.Model.CreateUserResponse).
/// 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 UserName parameter.
/// The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^UserName' 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.UserName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-APSUser (CreateUser)"))
{
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.UserName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AuthenticationType = this.AuthenticationType;
#if MODULAR
if (this.AuthenticationType == null && ParameterWasBound(nameof(this.AuthenticationType)))
{
WriteWarning("You are passing $null as a value for parameter AuthenticationType 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.MessageAction = this.MessageAction;
context.UserName = this.UserName;
#if MODULAR
if (this.UserName == null && ParameterWasBound(nameof(this.UserName)))
{
WriteWarning("You are passing $null as a value for parameter UserName 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.AppStream.Model.CreateUserRequest();
if (cmdletContext.AuthenticationType != null)
{
request.AuthenticationType = cmdletContext.AuthenticationType;
}
if (cmdletContext.FirstName != null)
{
request.FirstName = cmdletContext.FirstName;
}
if (cmdletContext.LastName != null)
{
request.LastName = cmdletContext.LastName;
}
if (cmdletContext.MessageAction != null)
{
request.MessageAction = cmdletContext.MessageAction;
}
if (cmdletContext.UserName != null)
{
request.UserName = cmdletContext.UserName;
}
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.AppStream.Model.CreateUserResponse CallAWSServiceOperation(IAmazonAppStream client, Amazon.AppStream.Model.CreateUserRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon AppStream", "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.AppStream.AuthenticationType AuthenticationType { get; set; }
public System.String FirstName { get; set; }
public System.String LastName { get; set; }
public Amazon.AppStream.MessageAction MessageAction { get; set; }
public System.String UserName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}