/*******************************************************************************
* 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.OpsWorks;
using Amazon.OpsWorks.Model;
namespace Amazon.PowerShell.Cmdlets.OPS
{
///
/// Describes an instance's Amazon EBS volumes.
///
///
/// This call accepts only one resource-identifying parameter.
/// Required Permissions: To use this action, an IAM user must have a Show, Deploy,
/// or Manage permissions level for the stack, or an attached policy that explicitly grants
/// permissions. For more information about user permissions, see Managing
/// User Permissions.
///
///
[Cmdlet("Get", "OPSVolume")]
[OutputType("Amazon.OpsWorks.Model.Volume")]
[AWSCmdlet("Calls the AWS OpsWorks DescribeVolumes API operation.", Operation = new[] {"DescribeVolumes"}, SelectReturnType = typeof(Amazon.OpsWorks.Model.DescribeVolumesResponse), LegacyAlias="Get-OPSVolumes")]
[AWSCmdletOutput("Amazon.OpsWorks.Model.Volume or Amazon.OpsWorks.Model.DescribeVolumesResponse",
"This cmdlet returns a collection of Amazon.OpsWorks.Model.Volume objects.",
"The service call response (type Amazon.OpsWorks.Model.DescribeVolumesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetOPSVolumeCmdlet : AmazonOpsWorksClientCmdlet, IExecutor
{
#region Parameter InstanceId
///
///
/// The instance ID. If you use this parameter, DescribeVolumes returns descriptions
/// of the volumes associated with the specified instance.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String InstanceId { get; set; }
#endregion
#region Parameter RaidArrayId
///
///
/// The RAID array ID. If you use this parameter, DescribeVolumes returns
/// descriptions of the volumes associated with the specified RAID array.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
public System.String RaidArrayId { get; set; }
#endregion
#region Parameter StackId
///
///
/// A stack ID. The action describes the stack's registered Amazon EBS volumes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StackId { get; set; }
#endregion
#region Parameter VolumeId
///
///
/// Am array of volume IDs. If you use this parameter, DescribeVolumes returns
/// descriptions of the specified volumes. Otherwise, it returns a description of every
/// volume.
///
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
[Alias("VolumeIds")]
public System.String[] VolumeId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Volumes'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorks.Model.DescribeVolumesResponse).
/// Specifying the name of a property of type Amazon.OpsWorks.Model.DescribeVolumesResponse 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; } = "Volumes";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the InstanceId parameter.
/// The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.InstanceId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.InstanceId = this.InstanceId;
context.RaidArrayId = this.RaidArrayId;
context.StackId = this.StackId;
if (this.VolumeId != null)
{
context.VolumeId = new List(this.VolumeId);
}
// 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.OpsWorks.Model.DescribeVolumesRequest();
if (cmdletContext.InstanceId != null)
{
request.InstanceId = cmdletContext.InstanceId;
}
if (cmdletContext.RaidArrayId != null)
{
request.RaidArrayId = cmdletContext.RaidArrayId;
}
if (cmdletContext.StackId != null)
{
request.StackId = cmdletContext.StackId;
}
if (cmdletContext.VolumeId != null)
{
request.VolumeIds = cmdletContext.VolumeId;
}
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.OpsWorks.Model.DescribeVolumesResponse CallAWSServiceOperation(IAmazonOpsWorks client, Amazon.OpsWorks.Model.DescribeVolumesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS OpsWorks", "DescribeVolumes");
try
{
#if DESKTOP
return client.DescribeVolumes(request);
#elif CORECLR
return client.DescribeVolumesAsync(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 InstanceId { get; set; }
public System.String RaidArrayId { get; set; }
public System.String StackId { get; set; }
public List VolumeId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Volumes;
}
}
}