/*******************************************************************************
* 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.ElastiCache;
using Amazon.ElastiCache.Model;
namespace Amazon.PowerShell.Cmdlets.EC
{
///
/// For Redis engine version 6.0 onwards: Creates a Redis user. For more information,
/// see Using
/// Role Based Access Control (RBAC).
///
[Cmdlet("New", "ECUser", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ElastiCache.Model.CreateUserResponse")]
[AWSCmdlet("Calls the Amazon ElastiCache CreateUser API operation.", Operation = new[] {"CreateUser"}, SelectReturnType = typeof(Amazon.ElastiCache.Model.CreateUserResponse))]
[AWSCmdletOutput("Amazon.ElastiCache.Model.CreateUserResponse",
"This cmdlet returns an Amazon.ElastiCache.Model.CreateUserResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewECUserCmdlet : AmazonElastiCacheClientCmdlet, IExecutor
{
#region Parameter AccessString
///
///
/// Access permissions string used for this user.
///
///
#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 AccessString { get; set; }
#endregion
#region Parameter Engine
///
///
/// The current supported value is Redis.
///
///
#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 Engine { get; set; }
#endregion
#region Parameter NoPasswordRequired
///
///
/// Indicates a password is not required for this user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? NoPasswordRequired { get; set; }
#endregion
#region Parameter AuthenticationMode_Password
///
///
/// Specifies the passwords to use for authentication if Type
is set to password
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AuthenticationMode_Passwords")]
public System.String[] AuthenticationMode_Password { get; set; }
#endregion
#region Parameter Password
///
///
/// Passwords used for this user. You can create up to two passwords for each user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Passwords")]
public System.String[] Password { get; set; }
#endregion
#region Parameter Tag
///
///
/// A list of tags to be added to this resource. A tag is a key-value pair. A tag key
/// must be accompanied by a tag value, although null is accepted.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.ElastiCache.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter AuthenticationMode_Type
///
///
/// Specifies the authentication type. Possible options are IAM authentication, password
/// and no password.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.ElastiCache.InputAuthenticationType")]
public Amazon.ElastiCache.InputAuthenticationType AuthenticationMode_Type { get; set; }
#endregion
#region Parameter UserId
///
///
/// The ID of the user.
///
///
#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 UserId { get; set; }
#endregion
#region Parameter UserName
///
///
/// The username of the user.
///
///
#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 UserName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElastiCache.Model.CreateUserResponse).
/// Specifying the name of a property of type Amazon.ElastiCache.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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the UserId parameter.
/// The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^UserId' 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.UserId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-ECUser (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.UserId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AccessString = this.AccessString;
#if MODULAR
if (this.AccessString == null && ParameterWasBound(nameof(this.AccessString)))
{
WriteWarning("You are passing $null as a value for parameter AccessString 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.AuthenticationMode_Password != null)
{
context.AuthenticationMode_Password = new List(this.AuthenticationMode_Password);
}
context.AuthenticationMode_Type = this.AuthenticationMode_Type;
context.Engine = this.Engine;
#if MODULAR
if (this.Engine == null && ParameterWasBound(nameof(this.Engine)))
{
WriteWarning("You are passing $null as a value for parameter Engine 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.NoPasswordRequired = this.NoPasswordRequired;
if (this.Password != null)
{
context.Password = new List(this.Password);
}
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.UserId = this.UserId;
#if MODULAR
if (this.UserId == null && ParameterWasBound(nameof(this.UserId)))
{
WriteWarning("You are passing $null as a value for parameter UserId 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.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.ElastiCache.Model.CreateUserRequest();
if (cmdletContext.AccessString != null)
{
request.AccessString = cmdletContext.AccessString;
}
// populate AuthenticationMode
var requestAuthenticationModeIsNull = true;
request.AuthenticationMode = new Amazon.ElastiCache.Model.AuthenticationMode();
List requestAuthenticationMode_authenticationMode_Password = null;
if (cmdletContext.AuthenticationMode_Password != null)
{
requestAuthenticationMode_authenticationMode_Password = cmdletContext.AuthenticationMode_Password;
}
if (requestAuthenticationMode_authenticationMode_Password != null)
{
request.AuthenticationMode.Passwords = requestAuthenticationMode_authenticationMode_Password;
requestAuthenticationModeIsNull = false;
}
Amazon.ElastiCache.InputAuthenticationType requestAuthenticationMode_authenticationMode_Type = null;
if (cmdletContext.AuthenticationMode_Type != null)
{
requestAuthenticationMode_authenticationMode_Type = cmdletContext.AuthenticationMode_Type;
}
if (requestAuthenticationMode_authenticationMode_Type != null)
{
request.AuthenticationMode.Type = requestAuthenticationMode_authenticationMode_Type;
requestAuthenticationModeIsNull = false;
}
// determine if request.AuthenticationMode should be set to null
if (requestAuthenticationModeIsNull)
{
request.AuthenticationMode = null;
}
if (cmdletContext.Engine != null)
{
request.Engine = cmdletContext.Engine;
}
if (cmdletContext.NoPasswordRequired != null)
{
request.NoPasswordRequired = cmdletContext.NoPasswordRequired.Value;
}
if (cmdletContext.Password != null)
{
request.Passwords = cmdletContext.Password;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.UserId != null)
{
request.UserId = cmdletContext.UserId;
}
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.ElastiCache.Model.CreateUserResponse CallAWSServiceOperation(IAmazonElastiCache client, Amazon.ElastiCache.Model.CreateUserRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon ElastiCache", "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 System.String AccessString { get; set; }
public List AuthenticationMode_Password { get; set; }
public Amazon.ElastiCache.InputAuthenticationType AuthenticationMode_Type { get; set; }
public System.String Engine { get; set; }
public System.Boolean? NoPasswordRequired { get; set; }
public List Password { get; set; }
public List Tag { get; set; }
public System.String UserId { get; set; }
public System.String UserName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}