/******************************************************************************* * 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.WAFV2; using Amazon.WAFV2.Model; namespace Amazon.PowerShell.Cmdlets.WAF2 { /// /// Defines the versions of your managed rule set that you are offering to the customers. /// Customers see your offerings as managed rule groups with versioning. /// /// /// This is intended for use only by vendors of managed rule sets. Vendors are Amazon /// Web Services and Amazon Web Services Marketplace sellers. /// /// Vendors, you can use the managed rule set APIs to provide controlled rollout of your /// versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, /// GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. /// /// Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. /// The name that you provide here for your managed rule set is the name the customer /// sees for the corresponding managed rule group. Customers can retrieve the available /// versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. /// You provide a rule group specification for each version. For each managed rule set, /// you must specify a version that you recommend using. /// /// To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate. /// /// [Cmdlet("Write", "WAF2ManagedRuleSetVersion", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS WAF V2 PutManagedRuleSetVersions API operation.", Operation = new[] {"PutManagedRuleSetVersions"}, SelectReturnType = typeof(Amazon.WAFV2.Model.PutManagedRuleSetVersionsResponse))] [AWSCmdletOutput("System.String or Amazon.WAFV2.Model.PutManagedRuleSetVersionsResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.WAFV2.Model.PutManagedRuleSetVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteWAF2ManagedRuleSetVersionCmdlet : AmazonWAFV2ClientCmdlet, IExecutor { #region Parameter Id /// /// /// A unique identifier for the managed rule set. The ID is returned in the responses /// to commands like list. You provide it to operations like get /// and update. /// /// #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 Id { get; set; } #endregion #region Parameter LockToken /// /// /// A token used for optimistic locking. WAF returns a token to your get /// and list requests, to mark the state of the entity at the time of the /// request. To make changes to the entity associated with the token, you provide the /// token to operations like update and delete. WAF uses the /// token to ensure that no changes have been made to the entity since you last retrieved /// it. If a change has been made, the update fails with a WAFOptimisticLockException. /// If this happens, perform another get, and use the new token returned /// by that operation. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String LockToken { get; set; } #endregion #region Parameter Name /// /// /// The name of the managed rule set. You use this, along with the rule set ID, to identify /// the rule set.This name is assigned to the corresponding managed rule group, which your customers /// can access and use. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Name { get; set; } #endregion #region Parameter RecommendedVersion /// /// /// The version of the named managed rule group that you'd like your customers to choose, /// from among your version offerings. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RecommendedVersion { get; set; } #endregion #region Parameter Scope /// /// /// Specifies whether this is for an Amazon CloudFront distribution or for a regional /// application. A regional application can be an Application Load Balancer (ALB), an /// Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, /// an App Runner service, or an Amazon Web Services Verified Access instance. To work with CloudFront, you must also specify the Region US East (N. Virginia) as /// follows: /// /// #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.WAFV2.Scope")] public Amazon.WAFV2.Scope Scope { get; set; } #endregion #region Parameter VersionsToPublish /// /// /// The versions of the named managed rule group that you want to offer to your customers. /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Collections.Hashtable VersionsToPublish { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'NextLockToken'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.PutManagedRuleSetVersionsResponse). /// Specifying the name of a property of type Amazon.WAFV2.Model.PutManagedRuleSetVersionsResponse 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; } = "NextLockToken"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Id parameter. /// The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Id' 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.Id), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-WAF2ManagedRuleSetVersion (PutManagedRuleSetVersions)")) { 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.Id; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Id = this.Id; #if MODULAR if (this.Id == null && ParameterWasBound(nameof(this.Id))) { WriteWarning("You are passing $null as a value for parameter Id 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.LockToken = this.LockToken; #if MODULAR if (this.LockToken == null && ParameterWasBound(nameof(this.LockToken))) { WriteWarning("You are passing $null as a value for parameter LockToken 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.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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.RecommendedVersion = this.RecommendedVersion; context.Scope = this.Scope; #if MODULAR if (this.Scope == null && ParameterWasBound(nameof(this.Scope))) { WriteWarning("You are passing $null as a value for parameter Scope 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 if (this.VersionsToPublish != null) { context.VersionsToPublish = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.VersionsToPublish.Keys) { context.VersionsToPublish.Add((String)hashKey, (VersionToPublish)(this.VersionsToPublish[hashKey])); } } // 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.WAFV2.Model.PutManagedRuleSetVersionsRequest(); if (cmdletContext.Id != null) { request.Id = cmdletContext.Id; } if (cmdletContext.LockToken != null) { request.LockToken = cmdletContext.LockToken; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.RecommendedVersion != null) { request.RecommendedVersion = cmdletContext.RecommendedVersion; } if (cmdletContext.Scope != null) { request.Scope = cmdletContext.Scope; } if (cmdletContext.VersionsToPublish != null) { request.VersionsToPublish = cmdletContext.VersionsToPublish; } 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.WAFV2.Model.PutManagedRuleSetVersionsResponse CallAWSServiceOperation(IAmazonWAFV2 client, Amazon.WAFV2.Model.PutManagedRuleSetVersionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS WAF V2", "PutManagedRuleSetVersions"); try { #if DESKTOP return client.PutManagedRuleSetVersions(request); #elif CORECLR return client.PutManagedRuleSetVersionsAsync(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 Id { get; set; } public System.String LockToken { get; set; } public System.String Name { get; set; } public System.String RecommendedVersion { get; set; } public Amazon.WAFV2.Scope Scope { get; set; } public Dictionary VersionsToPublish { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.NextLockToken; } } }