/******************************************************************************* * 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.IdentityManagement; using Amazon.IdentityManagement.Model; namespace Amazon.PowerShell.Cmdlets.IAM { /// /// Enables the specified MFA device and associates it with the specified IAM user. When /// enabled, the MFA device is required for every subsequent login by the IAM user associated /// with the device. /// [Cmdlet("Enable", "IAMMFADevice", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Identity and Access Management EnableMFADevice API operation.", Operation = new[] {"EnableMFADevice"}, SelectReturnType = typeof(Amazon.IdentityManagement.Model.EnableMFADeviceResponse))] [AWSCmdletOutput("None or Amazon.IdentityManagement.Model.EnableMFADeviceResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.IdentityManagement.Model.EnableMFADeviceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class EnableIAMMFADeviceCmdlet : AmazonIdentityManagementServiceClientCmdlet, IExecutor { #region Parameter AuthenticationCode1 /// /// /// An authentication code emitted by the device. The format for this parameter is a string of six digits.Submit your request immediately after generating the authentication codes. If you /// generate the codes and then wait too long to submit the request, the MFA device successfully /// associates with the user but the MFA device becomes out of sync. This happens because /// time-based one-time passwords (TOTP) expire after a short period of time. If this /// happens, you can resync /// the device. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String AuthenticationCode1 { get; set; } #endregion #region Parameter AuthenticationCode2 /// /// /// A subsequent authentication code emitted by the device.The format for this parameter is a string of six digits.Submit your request immediately after generating the authentication codes. If you /// generate the codes and then wait too long to submit the request, the MFA device successfully /// associates with the user but the MFA device becomes out of sync. This happens because /// time-based one-time passwords (TOTP) expire after a short period of time. If this /// happens, you can resync /// the device. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String AuthenticationCode2 { get; set; } #endregion #region Parameter SerialNumber /// /// /// The serial number that uniquely identifies the MFA device. For virtual MFA devices, /// the serial number is the device ARN.This parameter allows (through its regex /// pattern) a string of characters consisting of upper and lowercase alphanumeric /// characters with no spaces. You can also include any of the following characters: =,.@:/- /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SerialNumber { get; set; } #endregion #region Parameter UserName /// /// /// The name of the IAM user for whom you want to enable the MFA device.This parameter allows (through its regex /// pattern) a string of characters consisting of upper and lowercase alphanumeric /// characters with no spaces. You can also include any of the following characters: _+=,.@- /// /// #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.IdentityManagement.Model.EnableMFADeviceResponse). /// 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, "Enable-IAMMFADevice (EnableMFADevice)")) { 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.AuthenticationCode1 = this.AuthenticationCode1; #if MODULAR if (this.AuthenticationCode1 == null && ParameterWasBound(nameof(this.AuthenticationCode1))) { WriteWarning("You are passing $null as a value for parameter AuthenticationCode1 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.AuthenticationCode2 = this.AuthenticationCode2; #if MODULAR if (this.AuthenticationCode2 == null && ParameterWasBound(nameof(this.AuthenticationCode2))) { WriteWarning("You are passing $null as a value for parameter AuthenticationCode2 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.SerialNumber = this.SerialNumber; #if MODULAR if (this.SerialNumber == null && ParameterWasBound(nameof(this.SerialNumber))) { WriteWarning("You are passing $null as a value for parameter SerialNumber 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.IdentityManagement.Model.EnableMFADeviceRequest(); if (cmdletContext.AuthenticationCode1 != null) { request.AuthenticationCode1 = cmdletContext.AuthenticationCode1; } if (cmdletContext.AuthenticationCode2 != null) { request.AuthenticationCode2 = cmdletContext.AuthenticationCode2; } if (cmdletContext.SerialNumber != null) { request.SerialNumber = cmdletContext.SerialNumber; } 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.IdentityManagement.Model.EnableMFADeviceResponse CallAWSServiceOperation(IAmazonIdentityManagementService client, Amazon.IdentityManagement.Model.EnableMFADeviceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Identity and Access Management", "EnableMFADevice"); try { #if DESKTOP return client.EnableMFADevice(request); #elif CORECLR return client.EnableMFADeviceAsync(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 AuthenticationCode1 { get; set; } public System.String AuthenticationCode2 { get; set; } public System.String SerialNumber { get; set; } public System.String UserName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }