/*******************************************************************************
* 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.CloudFormation;
using Amazon.CloudFormation.Model;
namespace Amazon.PowerShell.Cmdlets.CFN
{
///
/// Returns Amazon Web Services resource descriptions for running and deleted stacks.
/// If StackName
is specified, all the associated resources that are part
/// of the stack are returned. If PhysicalResourceId
is specified, the associated
/// resources of the stack that the resource belongs to are returned.
///
///
/// Only the first 100 resources will be returned. If your stack has more resources than
/// this, you should use ListStackResources
instead.
///
/// For deleted stacks, DescribeStackResources
returns resource information
/// for up to 90 days after the stack has been deleted.
///
/// You must specify either StackName
or PhysicalResourceId
,
/// but not both. In addition, you can specify LogicalResourceId
to filter
/// the returned result. For more information about resources, the LogicalResourceId
/// and PhysicalResourceId
, go to the CloudFormation
/// User Guide.
///
/// A ValidationError
is returned if you specify both StackName
/// and PhysicalResourceId
in the same request.
///
///
[Cmdlet("Get", "CFNStackResourceList")]
[OutputType("Amazon.CloudFormation.Model.StackResource")]
[AWSCmdlet("Calls the AWS CloudFormation DescribeStackResources API operation.", Operation = new[] {"DescribeStackResources"}, SelectReturnType = typeof(Amazon.CloudFormation.Model.DescribeStackResourcesResponse), LegacyAlias="Get-CFNStackResources")]
[AWSCmdletOutput("Amazon.CloudFormation.Model.StackResource or Amazon.CloudFormation.Model.DescribeStackResourcesResponse",
"This cmdlet returns a collection of Amazon.CloudFormation.Model.StackResource objects.",
"The service call response (type Amazon.CloudFormation.Model.DescribeStackResourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetCFNStackResourceListCmdlet : AmazonCloudFormationClientCmdlet, IExecutor
{
#region Parameter LogicalResourceId
///
///
/// The logical name of the resource as specified in the template.Default: There is no default value.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LogicalResourceId { get; set; }
#endregion
#region Parameter PhysicalResourceId
///
///
/// The name or unique identifier that corresponds to a physical instance ID of a resource
/// supported by CloudFormation.For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId
/// corresponds to the InstanceId
. You can pass the EC2 InstanceId
/// to DescribeStackResources
to find which stack the instance belongs to
/// and what other resources are part of the stack.Required: Conditional. If you don't specify PhysicalResourceId
, you must
/// specify StackName
.Default: There is no default value.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PhysicalResourceId { get; set; }
#endregion
#region Parameter StackName
///
///
/// The name or the unique stack ID that is associated with the stack, which aren't always
/// interchangeable:- Running stacks: You can specify either the stack's name or its unique stack ID.
- Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.Required: Conditional. If you don't specify StackName
, you must specify
/// PhysicalResourceId
.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String StackName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'StackResources'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFormation.Model.DescribeStackResourcesResponse).
/// Specifying the name of a property of type Amazon.CloudFormation.Model.DescribeStackResourcesResponse 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; } = "StackResources";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the StackName parameter.
/// The -PassThru parameter is deprecated, use -Select '^StackName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StackName' 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.StackName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.LogicalResourceId = this.LogicalResourceId;
context.PhysicalResourceId = this.PhysicalResourceId;
context.StackName = this.StackName;
// 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.CloudFormation.Model.DescribeStackResourcesRequest();
if (cmdletContext.LogicalResourceId != null)
{
request.LogicalResourceId = cmdletContext.LogicalResourceId;
}
if (cmdletContext.PhysicalResourceId != null)
{
request.PhysicalResourceId = cmdletContext.PhysicalResourceId;
}
if (cmdletContext.StackName != null)
{
request.StackName = cmdletContext.StackName;
}
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.CloudFormation.Model.DescribeStackResourcesResponse CallAWSServiceOperation(IAmazonCloudFormation client, Amazon.CloudFormation.Model.DescribeStackResourcesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CloudFormation", "DescribeStackResources");
try
{
#if DESKTOP
return client.DescribeStackResources(request);
#elif CORECLR
return client.DescribeStackResourcesAsync(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 LogicalResourceId { get; set; }
public System.String PhysicalResourceId { get; set; }
public System.String StackName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.StackResources;
}
}
}