/******************************************************************************* * 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.CloudWatchLogs; using Amazon.CloudWatchLogs.Model; namespace Amazon.PowerShell.Cmdlets.CWL { /// /// Creates or updates a query definition for CloudWatch Logs Insights. For more information, /// see Analyzing /// Log Data with CloudWatch Logs Insights. /// /// /// /// To update a query definition, specify its queryDefinitionId in your request. /// The values of name, queryString, and logGroupNames /// are changed to the values that you specify in your update operation. No current values /// are retained from the current query definition. For example, imagine updating a current /// query definition that includes log groups. If you don't specify the logGroupNames /// parameter in your update operation, the query definition changes to contain no log /// groups. /// /// You must have the logs:PutQueryDefinition permission to be able to perform /// this operation. /// /// [Cmdlet("Write", "CWLQueryDefinition", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon CloudWatch Logs PutQueryDefinition API operation.", Operation = new[] {"PutQueryDefinition"}, SelectReturnType = typeof(Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse))] [AWSCmdletOutput("System.String or Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteCWLQueryDefinitionCmdlet : AmazonCloudWatchLogsClientCmdlet, IExecutor { #region Parameter LogGroupName /// /// /// Use this parameter to include specific log groups as part of your query definition.If you are updating a query definition and you omit this parameter, then the updated /// definition will contain no log groups. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LogGroupNames")] public System.String[] LogGroupName { get; set; } #endregion #region Parameter Name /// /// /// A name for the query definition. If you are saving numerous query definitions, we /// recommend that you name them. This way, you can find the ones you want by using the /// first part of the name as a filter in the queryDefinitionNamePrefix parameter /// of DescribeQueryDefinitions. /// /// #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 Name { get; set; } #endregion #region Parameter QueryDefinitionId /// /// /// If you are updating a query definition, use this parameter to specify the ID of the /// query definition that you want to update. You can use DescribeQueryDefinitions /// to retrieve the IDs of your saved query definitions.If you are creating a query definition, do not specify this parameter. CloudWatch /// generates a unique ID for the new query definition and include it in the response /// to this operation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String QueryDefinitionId { get; set; } #endregion #region Parameter QueryString /// /// /// The query string to use for this definition. For more information, see CloudWatch /// Logs Insights Query Syntax. /// /// #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 QueryString { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'QueryDefinitionId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse). /// Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutQueryDefinitionResponse 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; } = "QueryDefinitionId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Name parameter. /// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CWLQueryDefinition (PutQueryDefinition)")) { 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.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.LogGroupName != null) { context.LogGroupName = new List(this.LogGroupName); } 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.QueryDefinitionId = this.QueryDefinitionId; context.QueryString = this.QueryString; #if MODULAR if (this.QueryString == null && ParameterWasBound(nameof(this.QueryString))) { WriteWarning("You are passing $null as a value for parameter QueryString 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.CloudWatchLogs.Model.PutQueryDefinitionRequest(); if (cmdletContext.LogGroupName != null) { request.LogGroupNames = cmdletContext.LogGroupName; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.QueryDefinitionId != null) { request.QueryDefinitionId = cmdletContext.QueryDefinitionId; } if (cmdletContext.QueryString != null) { request.QueryString = cmdletContext.QueryString; } 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.CloudWatchLogs.Model.PutQueryDefinitionResponse CallAWSServiceOperation(IAmazonCloudWatchLogs client, Amazon.CloudWatchLogs.Model.PutQueryDefinitionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch Logs", "PutQueryDefinition"); try { #if DESKTOP return client.PutQueryDefinition(request); #elif CORECLR return client.PutQueryDefinitionAsync(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 LogGroupName { get; set; } public System.String Name { get; set; } public System.String QueryDefinitionId { get; set; } public System.String QueryString { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.QueryDefinitionId; } } }