/******************************************************************************* * 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.WorkSpaces; using Amazon.WorkSpaces.Model; namespace Amazon.PowerShell.Cmdlets.WKS { /// /// Registers the specified directory. This operation is asynchronous and returns before /// the WorkSpace directory is registered. If this is the first time you are registering /// a directory, you will need to create the workspaces_DefaultRole role before you can /// register a directory. For more information, see /// Creating the workspaces_DefaultRole Role. /// [Cmdlet("Register", "WKSWorkspaceDirectory", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon WorkSpaces RegisterWorkspaceDirectory API operation.", Operation = new[] {"RegisterWorkspaceDirectory"}, SelectReturnType = typeof(Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse))] [AWSCmdletOutput("None or Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RegisterWKSWorkspaceDirectoryCmdlet : AmazonWorkSpacesClientCmdlet, IExecutor { #region Parameter DirectoryId /// /// /// The identifier of the directory. You cannot register a directory if it does not have /// a status of Active. If the directory does not have a status of Active, you will receive /// an InvalidResourceStateException error. If you have already registered the maximum /// number of directories that you can register with Amazon WorkSpaces, you will receive /// a ResourceLimitExceededException error. Deregister directories that you are not using /// for WorkSpaces, and try again. /// /// #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 DirectoryId { get; set; } #endregion #region Parameter EnableSelfService /// /// /// Indicates whether self-service capabilities are enabled or disabled. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? EnableSelfService { get; set; } #endregion #region Parameter EnableWorkDoc /// /// /// Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this /// parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException /// error. Set EnableWorkDocs to disabled, and try again. /// /// #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] [Alias("EnableWorkDocs")] public System.Boolean? EnableWorkDoc { get; set; } #endregion #region Parameter SubnetId /// /// /// The identifiers of the subnets for your virtual private cloud (VPC). Make sure that /// the subnets are in supported Availability Zones. The subnets must also be in separate /// Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException /// error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SubnetIds")] public System.String[] SubnetId { get; set; } #endregion #region Parameter Tag /// /// /// The tags associated with the directory. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.WorkSpaces.Model.Tag[] Tag { get; set; } #endregion #region Parameter Tenancy /// /// /// Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your /// Own License (BYOL) images, this value must be set to DEDICATED and your /// Amazon Web Services account must be enabled for BYOL. If your account has not been /// enabled for BYOL, you will receive an InvalidParameterValuesException error. For more /// information about BYOL images, see Bring /// Your Own Windows Desktop Images. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.WorkSpaces.Tenancy")] public Amazon.WorkSpaces.Tenancy Tenancy { 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.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse). /// 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 DirectoryId parameter. /// The -PassThru parameter is deprecated, use -Select '^DirectoryId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DirectoryId' 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.DirectoryId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Register-WKSWorkspaceDirectory (RegisterWorkspaceDirectory)")) { 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.DirectoryId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DirectoryId = this.DirectoryId; #if MODULAR if (this.DirectoryId == null && ParameterWasBound(nameof(this.DirectoryId))) { WriteWarning("You are passing $null as a value for parameter DirectoryId 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.EnableSelfService = this.EnableSelfService; context.EnableWorkDoc = this.EnableWorkDoc; #if MODULAR if (this.EnableWorkDoc == null && ParameterWasBound(nameof(this.EnableWorkDoc))) { WriteWarning("You are passing $null as a value for parameter EnableWorkDoc 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.SubnetId != null) { context.SubnetId = new List(this.SubnetId); } if (this.Tag != null) { context.Tag = new List(this.Tag); } context.Tenancy = this.Tenancy; // 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.WorkSpaces.Model.RegisterWorkspaceDirectoryRequest(); if (cmdletContext.DirectoryId != null) { request.DirectoryId = cmdletContext.DirectoryId; } if (cmdletContext.EnableSelfService != null) { request.EnableSelfService = cmdletContext.EnableSelfService.Value; } if (cmdletContext.EnableWorkDoc != null) { request.EnableWorkDocs = cmdletContext.EnableWorkDoc.Value; } if (cmdletContext.SubnetId != null) { request.SubnetIds = cmdletContext.SubnetId; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.Tenancy != null) { request.Tenancy = cmdletContext.Tenancy; } 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.WorkSpaces.Model.RegisterWorkspaceDirectoryResponse CallAWSServiceOperation(IAmazonWorkSpaces client, Amazon.WorkSpaces.Model.RegisterWorkspaceDirectoryRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces", "RegisterWorkspaceDirectory"); try { #if DESKTOP return client.RegisterWorkspaceDirectory(request); #elif CORECLR return client.RegisterWorkspaceDirectoryAsync(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 DirectoryId { get; set; } public System.Boolean? EnableSelfService { get; set; } public System.Boolean? EnableWorkDoc { get; set; } public List SubnetId { get; set; } public List Tag { get; set; } public Amazon.WorkSpaces.Tenancy Tenancy { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }