/*******************************************************************************
* 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
{
///
/// Detects whether a stack's actual configuration differs, or has drifted, from
/// its expected configuration, as defined in the stack template and any values specified
/// as template parameters. For each resource in the stack that supports drift detection,
/// CloudFormation compares the actual configuration of the resource with its expected
/// template configuration. Only resource properties explicitly defined in the stack template
/// are checked for drift. A stack is considered to have drifted if one or more of its
/// resources differ from their expected template configurations. For more information,
/// see Detecting
/// Unregulated Configuration Changes to Stacks and Resources.
///
///
///
/// Use DetectStackDrift
to detect drift on all supported resources for a
/// given stack, or DetectStackResourceDrift to detect drift on individual resources.
///
/// For a list of stack resources that currently support drift detection, see Resources
/// that Support Drift Detection.
/// DetectStackDrift
can take up to several minutes, depending on the number
/// of resources contained within the stack. Use DescribeStackDriftDetectionStatus
/// to monitor the progress of a detect stack drift operation. Once the drift detection
/// operation has completed, use DescribeStackResourceDrifts to return drift information
/// about the stack and its resources.
///
/// When detecting drift on a stack, CloudFormation doesn't detect drift on any nested
/// stacks belonging to that stack. Perform DetectStackDrift
directly on
/// the nested stack itself.
///
///
[Cmdlet("Start", "CFNStackDriftDetection", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS CloudFormation DetectStackDrift API operation.", Operation = new[] {"DetectStackDrift"}, SelectReturnType = typeof(Amazon.CloudFormation.Model.DetectStackDriftResponse))]
[AWSCmdletOutput("System.String or Amazon.CloudFormation.Model.DetectStackDriftResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.CloudFormation.Model.DetectStackDriftResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class StartCFNStackDriftDetectionCmdlet : AmazonCloudFormationClientCmdlet, IExecutor
{
#region Parameter LogicalResourceId
///
///
/// The logical names of any resources you want to use as filters.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("LogicalResourceIds")]
public System.String[] LogicalResourceId { get; set; }
#endregion
#region Parameter StackName
///
///
/// The name of the stack for which you want to detect drift.
///
///
#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 StackName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'StackDriftDetectionId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFormation.Model.DetectStackDriftResponse).
/// Specifying the name of a property of type Amazon.CloudFormation.Model.DetectStackDriftResponse 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; } = "StackDriftDetectionId";
#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
#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.StackName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-CFNStackDriftDetection (DetectStackDrift)"))
{
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.StackName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.LogicalResourceId != null)
{
context.LogicalResourceId = new List(this.LogicalResourceId);
}
context.StackName = this.StackName;
#if MODULAR
if (this.StackName == null && ParameterWasBound(nameof(this.StackName)))
{
WriteWarning("You are passing $null as a value for parameter StackName 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.CloudFormation.Model.DetectStackDriftRequest();
if (cmdletContext.LogicalResourceId != null)
{
request.LogicalResourceIds = cmdletContext.LogicalResourceId;
}
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.DetectStackDriftResponse CallAWSServiceOperation(IAmazonCloudFormation client, Amazon.CloudFormation.Model.DetectStackDriftRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CloudFormation", "DetectStackDrift");
try
{
#if DESKTOP
return client.DetectStackDrift(request);
#elif CORECLR
return client.DetectStackDriftAsync(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 List LogicalResourceId { get; set; }
public System.String StackName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.StackDriftDetectionId;
}
}
}