/******************************************************************************* * 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.AccessAnalyzer; using Amazon.AccessAnalyzer.Model; namespace Amazon.PowerShell.Cmdlets.IAMAA { /// /// Requests the validation of a policy and returns a list of findings. The findings help /// you identify issues and provide actionable recommendations to resolve the issue and /// enable you to author functional policies that meet security best practices.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Use", "IAMAAPolicyValidation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.AccessAnalyzer.Model.ValidatePolicyFinding")] [AWSCmdlet("Calls the AWS IAM Access Analyzer ValidatePolicy API operation.", Operation = new[] {"ValidatePolicy"}, SelectReturnType = typeof(Amazon.AccessAnalyzer.Model.ValidatePolicyResponse))] [AWSCmdletOutput("Amazon.AccessAnalyzer.Model.ValidatePolicyFinding or Amazon.AccessAnalyzer.Model.ValidatePolicyResponse", "This cmdlet returns a collection of Amazon.AccessAnalyzer.Model.ValidatePolicyFinding objects.", "The service call response (type Amazon.AccessAnalyzer.Model.ValidatePolicyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UseIAMAAPolicyValidationCmdlet : AmazonAccessAnalyzerClientCmdlet, IExecutor { #region Parameter Locale /// /// /// The locale to use for localizing the findings. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.AccessAnalyzer.Locale")] public Amazon.AccessAnalyzer.Locale Locale { get; set; } #endregion #region Parameter PolicyDocument /// /// /// The JSON policy document to use as the content for the policy. /// /// #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 PolicyDocument { get; set; } #endregion #region Parameter PolicyType /// /// /// The type of policy to validate. Identity policies grant permissions to IAM principals. /// Identity policies include managed and inline policies for IAM roles, users, and groups. /// They also include service-control policies (SCPs) that are attached to an Amazon Web /// Services organization, organizational unit (OU), or an account.Resource policies grant permissions on Amazon Web Services resources. Resource policies /// include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You /// can provide a generic input such as identity policy or resource policy or a specific /// input such as managed policy or Amazon S3 bucket policy. /// /// #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] [AWSConstantClassSource("Amazon.AccessAnalyzer.PolicyType")] public Amazon.AccessAnalyzer.PolicyType PolicyType { get; set; } #endregion #region Parameter ValidatePolicyResourceType /// /// /// The type of resource to attach to your resource policy. Specify a value for the policy /// validation resource type only if the policy type is RESOURCE_POLICY. /// For example, to validate a resource policy to attach to an Amazon S3 bucket, you can /// choose AWS::S3::Bucket for the policy validation resource type.For resource types not supported as valid values, IAM Access Analyzer runs policy /// checks that apply to all resource policies. For example, to validate a resource policy /// to attach to a KMS key, do not specify a value for the policy validation resource /// type and IAM Access Analyzer will run policy checks that apply to all resource policies. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.AccessAnalyzer.ValidatePolicyResourceType")] public Amazon.AccessAnalyzer.ValidatePolicyResourceType ValidatePolicyResourceType { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of results to return in the response. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// A token used for pagination of results returned. /// /// ///
Note: This parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AccessAnalyzer.Model.ValidatePolicyResponse). /// Specifying the name of a property of type Amazon.AccessAnalyzer.Model.ValidatePolicyResponse 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; } = "Findings"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the PolicyDocument parameter. /// The -PassThru parameter is deprecated, use -Select '^PolicyDocument' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PolicyDocument' 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 #region Parameter NoAutoIteration /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Use-IAMAAPolicyValidation (ValidatePolicy)")) { 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.PolicyDocument; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Locale = this.Locale; context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.PolicyDocument = this.PolicyDocument; #if MODULAR if (this.PolicyDocument == null && ParameterWasBound(nameof(this.PolicyDocument))) { WriteWarning("You are passing $null as a value for parameter PolicyDocument 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.PolicyType = this.PolicyType; #if MODULAR if (this.PolicyType == null && ParameterWasBound(nameof(this.PolicyType))) { WriteWarning("You are passing $null as a value for parameter PolicyType 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.ValidatePolicyResourceType = this.ValidatePolicyResourceType; // 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; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.AccessAnalyzer.Model.ValidatePolicyRequest(); if (cmdletContext.Locale != null) { request.Locale = cmdletContext.Locale; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.PolicyDocument != null) { request.PolicyDocument = cmdletContext.PolicyDocument; } if (cmdletContext.PolicyType != null) { request.PolicyType = cmdletContext.PolicyType; } if (cmdletContext.ValidatePolicyResourceType != null) { request.ValidatePolicyResourceType = cmdletContext.ValidatePolicyResourceType; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.NextToken; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.NextToken; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.AccessAnalyzer.Model.ValidatePolicyResponse CallAWSServiceOperation(IAmazonAccessAnalyzer client, Amazon.AccessAnalyzer.Model.ValidatePolicyRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IAM Access Analyzer", "ValidatePolicy"); try { #if DESKTOP return client.ValidatePolicy(request); #elif CORECLR return client.ValidatePolicyAsync(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 Amazon.AccessAnalyzer.Locale Locale { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public System.String PolicyDocument { get; set; } public Amazon.AccessAnalyzer.PolicyType PolicyType { get; set; } public Amazon.AccessAnalyzer.ValidatePolicyResourceType ValidatePolicyResourceType { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Findings; } } }