/*******************************************************************************
* 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
{
///
/// Modifies the specified WorkSpace properties. For important information about how to
/// modify the size of the root and user volumes, see
/// Modify a WorkSpace.
///
///
/// The MANUAL
running mode value is only supported by Amazon WorkSpaces
/// Core. Contact your account team to be allow-listed to use this value. For more information,
/// see Amazon WorkSpaces Core.
///
///
[Cmdlet("Edit", "WKSWorkspaceProperty", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon WorkSpaces ModifyWorkspaceProperties API operation.", Operation = new[] {"ModifyWorkspaceProperties"}, SelectReturnType = typeof(Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse))]
[AWSCmdletOutput("None or Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class EditWKSWorkspacePropertyCmdlet : AmazonWorkSpacesClientCmdlet, IExecutor
{
#region Parameter WorkspaceProperties_ComputeTypeName
///
///
/// The compute type. For more information, see Amazon
/// WorkSpaces Bundles.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.WorkSpaces.Compute")]
public Amazon.WorkSpaces.Compute WorkspaceProperties_ComputeTypeName { get; set; }
#endregion
#region Parameter WorkspaceProperties_Protocol
///
///
/// The protocol. For more information, see
/// Protocols for Amazon WorkSpaces.- Only available for WorkSpaces created with PCoIP bundles.
- The
Protocols
property is case sensitive. Ensure you use PCOIP
/// or WSP
. - Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics,
/// GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("WorkspaceProperties_Protocols")]
public System.String[] WorkspaceProperties_Protocol { get; set; }
#endregion
#region Parameter WorkspaceProperties_RootVolumeSizeGib
///
///
/// The size of the root volume. For important information about how to modify the size
/// of the root and user volumes, see Modify
/// a WorkSpace.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? WorkspaceProperties_RootVolumeSizeGib { get; set; }
#endregion
#region Parameter WorkspaceProperties_RunningMode
///
///
/// The running mode. For more information, see Manage
/// the WorkSpace Running Mode.The MANUAL
value is only supported by Amazon WorkSpaces Core. Contact
/// your account team to be allow-listed to use this value. For more information, see
/// Amazon WorkSpaces Core.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.WorkSpaces.RunningMode")]
public Amazon.WorkSpaces.RunningMode WorkspaceProperties_RunningMode { get; set; }
#endregion
#region Parameter WorkspaceProperties_RunningModeAutoStopTimeoutInMinute
///
///
/// The time after a user logs off when WorkSpaces are automatically stopped. Configured
/// in 60-minute intervals.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("WorkspaceProperties_RunningModeAutoStopTimeoutInMinutes")]
public System.Int32? WorkspaceProperties_RunningModeAutoStopTimeoutInMinute { get; set; }
#endregion
#region Parameter WorkspaceProperties_UserVolumeSizeGib
///
///
/// The size of the user storage. For important information about how to modify the size
/// of the root and user volumes, see Modify
/// a WorkSpace.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? WorkspaceProperties_UserVolumeSizeGib { get; set; }
#endregion
#region Parameter WorkspaceId
///
///
/// The identifier of the WorkSpace.
///
///
#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 WorkspaceId { 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.ModifyWorkspacePropertiesResponse).
/// 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 WorkspaceId parameter.
/// The -PassThru parameter is deprecated, use -Select '^WorkspaceId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^WorkspaceId' 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.WorkspaceId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-WKSWorkspaceProperty (ModifyWorkspaceProperties)"))
{
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.WorkspaceId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.WorkspaceId = this.WorkspaceId;
#if MODULAR
if (this.WorkspaceId == null && ParameterWasBound(nameof(this.WorkspaceId)))
{
WriteWarning("You are passing $null as a value for parameter WorkspaceId 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.WorkspaceProperties_ComputeTypeName = this.WorkspaceProperties_ComputeTypeName;
if (this.WorkspaceProperties_Protocol != null)
{
context.WorkspaceProperties_Protocol = new List(this.WorkspaceProperties_Protocol);
}
context.WorkspaceProperties_RootVolumeSizeGib = this.WorkspaceProperties_RootVolumeSizeGib;
context.WorkspaceProperties_RunningMode = this.WorkspaceProperties_RunningMode;
context.WorkspaceProperties_RunningModeAutoStopTimeoutInMinute = this.WorkspaceProperties_RunningModeAutoStopTimeoutInMinute;
context.WorkspaceProperties_UserVolumeSizeGib = this.WorkspaceProperties_UserVolumeSizeGib;
// 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.ModifyWorkspacePropertiesRequest();
if (cmdletContext.WorkspaceId != null)
{
request.WorkspaceId = cmdletContext.WorkspaceId;
}
// populate WorkspaceProperties
var requestWorkspacePropertiesIsNull = true;
request.WorkspaceProperties = new Amazon.WorkSpaces.Model.WorkspaceProperties();
Amazon.WorkSpaces.Compute requestWorkspaceProperties_workspaceProperties_ComputeTypeName = null;
if (cmdletContext.WorkspaceProperties_ComputeTypeName != null)
{
requestWorkspaceProperties_workspaceProperties_ComputeTypeName = cmdletContext.WorkspaceProperties_ComputeTypeName;
}
if (requestWorkspaceProperties_workspaceProperties_ComputeTypeName != null)
{
request.WorkspaceProperties.ComputeTypeName = requestWorkspaceProperties_workspaceProperties_ComputeTypeName;
requestWorkspacePropertiesIsNull = false;
}
List requestWorkspaceProperties_workspaceProperties_Protocol = null;
if (cmdletContext.WorkspaceProperties_Protocol != null)
{
requestWorkspaceProperties_workspaceProperties_Protocol = cmdletContext.WorkspaceProperties_Protocol;
}
if (requestWorkspaceProperties_workspaceProperties_Protocol != null)
{
request.WorkspaceProperties.Protocols = requestWorkspaceProperties_workspaceProperties_Protocol;
requestWorkspacePropertiesIsNull = false;
}
System.Int32? requestWorkspaceProperties_workspaceProperties_RootVolumeSizeGib = null;
if (cmdletContext.WorkspaceProperties_RootVolumeSizeGib != null)
{
requestWorkspaceProperties_workspaceProperties_RootVolumeSizeGib = cmdletContext.WorkspaceProperties_RootVolumeSizeGib.Value;
}
if (requestWorkspaceProperties_workspaceProperties_RootVolumeSizeGib != null)
{
request.WorkspaceProperties.RootVolumeSizeGib = requestWorkspaceProperties_workspaceProperties_RootVolumeSizeGib.Value;
requestWorkspacePropertiesIsNull = false;
}
Amazon.WorkSpaces.RunningMode requestWorkspaceProperties_workspaceProperties_RunningMode = null;
if (cmdletContext.WorkspaceProperties_RunningMode != null)
{
requestWorkspaceProperties_workspaceProperties_RunningMode = cmdletContext.WorkspaceProperties_RunningMode;
}
if (requestWorkspaceProperties_workspaceProperties_RunningMode != null)
{
request.WorkspaceProperties.RunningMode = requestWorkspaceProperties_workspaceProperties_RunningMode;
requestWorkspacePropertiesIsNull = false;
}
System.Int32? requestWorkspaceProperties_workspaceProperties_RunningModeAutoStopTimeoutInMinute = null;
if (cmdletContext.WorkspaceProperties_RunningModeAutoStopTimeoutInMinute != null)
{
requestWorkspaceProperties_workspaceProperties_RunningModeAutoStopTimeoutInMinute = cmdletContext.WorkspaceProperties_RunningModeAutoStopTimeoutInMinute.Value;
}
if (requestWorkspaceProperties_workspaceProperties_RunningModeAutoStopTimeoutInMinute != null)
{
request.WorkspaceProperties.RunningModeAutoStopTimeoutInMinutes = requestWorkspaceProperties_workspaceProperties_RunningModeAutoStopTimeoutInMinute.Value;
requestWorkspacePropertiesIsNull = false;
}
System.Int32? requestWorkspaceProperties_workspaceProperties_UserVolumeSizeGib = null;
if (cmdletContext.WorkspaceProperties_UserVolumeSizeGib != null)
{
requestWorkspaceProperties_workspaceProperties_UserVolumeSizeGib = cmdletContext.WorkspaceProperties_UserVolumeSizeGib.Value;
}
if (requestWorkspaceProperties_workspaceProperties_UserVolumeSizeGib != null)
{
request.WorkspaceProperties.UserVolumeSizeGib = requestWorkspaceProperties_workspaceProperties_UserVolumeSizeGib.Value;
requestWorkspacePropertiesIsNull = false;
}
// determine if request.WorkspaceProperties should be set to null
if (requestWorkspacePropertiesIsNull)
{
request.WorkspaceProperties = null;
}
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.ModifyWorkspacePropertiesResponse CallAWSServiceOperation(IAmazonWorkSpaces client, Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces", "ModifyWorkspaceProperties");
try
{
#if DESKTOP
return client.ModifyWorkspaceProperties(request);
#elif CORECLR
return client.ModifyWorkspacePropertiesAsync(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 WorkspaceId { get; set; }
public Amazon.WorkSpaces.Compute WorkspaceProperties_ComputeTypeName { get; set; }
public List WorkspaceProperties_Protocol { get; set; }
public System.Int32? WorkspaceProperties_RootVolumeSizeGib { get; set; }
public Amazon.WorkSpaces.RunningMode WorkspaceProperties_RunningMode { get; set; }
public System.Int32? WorkspaceProperties_RunningModeAutoStopTimeoutInMinute { get; set; }
public System.Int32? WorkspaceProperties_UserVolumeSizeGib { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}