/******************************************************************************* * 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 { /// /// Uploads a batch of log events to the specified log stream. /// /// /// The sequence token is now ignored in PutLogEvents actions. PutLogEvents /// actions are always accepted and never return InvalidSequenceTokenException /// or DataAlreadyAcceptedException even if the sequence token is not valid. /// You can use parallel PutLogEvents actions on the same log stream. /// /// The batch of events must satisfy the following constraints: /// /// If a call to PutLogEvents returns "UnrecognizedClientException" the most /// likely cause is a non-valid Amazon Web Services access key ID or secret key. /// /// [Cmdlet("Write", "CWLLogEvent", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon CloudWatch Logs PutLogEvents API operation.", Operation = new[] {"PutLogEvents"}, SelectReturnType = typeof(Amazon.CloudWatchLogs.Model.PutLogEventsResponse), LegacyAlias="Write-CWLLogEvents")] [AWSCmdletOutput("System.String or Amazon.CloudWatchLogs.Model.PutLogEventsResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.CloudWatchLogs.Model.PutLogEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteCWLLogEventCmdlet : AmazonCloudWatchLogsClientCmdlet, IExecutor { #region Parameter LogEvent /// /// /// The log events. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("LogEvents")] public Amazon.CloudWatchLogs.Model.InputLogEvent[] LogEvent { get; set; } #endregion #region Parameter LogGroupName /// /// /// The name of the log group. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String LogGroupName { get; set; } #endregion #region Parameter LogStreamName /// /// /// The name of the log stream. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String LogStreamName { get; set; } #endregion #region Parameter SequenceToken /// /// /// The sequence token obtained from the response of the previous PutLogEvents /// call.The sequenceToken parameter is now ignored in PutLogEvents /// actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException /// or DataAlreadyAcceptedException even if the sequence token is not valid. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String SequenceToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'NextSequenceToken'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchLogs.Model.PutLogEventsResponse). /// Specifying the name of a property of type Amazon.CloudWatchLogs.Model.PutLogEventsResponse 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; } = "NextSequenceToken"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the SequenceToken parameter. /// The -PassThru parameter is deprecated, use -Select '^SequenceToken' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SequenceToken' 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.LogStreamName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CWLLogEvent (PutLogEvents)")) { 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.SequenceToken; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.LogEvent != null) { context.LogEvent = new List(this.LogEvent); } #if MODULAR if (this.LogEvent == null && ParameterWasBound(nameof(this.LogEvent))) { WriteWarning("You are passing $null as a value for parameter LogEvent 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.LogGroupName = this.LogGroupName; #if MODULAR if (this.LogGroupName == null && ParameterWasBound(nameof(this.LogGroupName))) { WriteWarning("You are passing $null as a value for parameter LogGroupName 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.LogStreamName = this.LogStreamName; #if MODULAR if (this.LogStreamName == null && ParameterWasBound(nameof(this.LogStreamName))) { WriteWarning("You are passing $null as a value for parameter LogStreamName 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.SequenceToken = this.SequenceToken; // 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.PutLogEventsRequest(); if (cmdletContext.LogEvent != null) { request.LogEvents = cmdletContext.LogEvent; } if (cmdletContext.LogGroupName != null) { request.LogGroupName = cmdletContext.LogGroupName; } if (cmdletContext.LogStreamName != null) { request.LogStreamName = cmdletContext.LogStreamName; } if (cmdletContext.SequenceToken != null) { request.SequenceToken = cmdletContext.SequenceToken; } 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.PutLogEventsResponse CallAWSServiceOperation(IAmazonCloudWatchLogs client, Amazon.CloudWatchLogs.Model.PutLogEventsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch Logs", "PutLogEvents"); try { #if DESKTOP return client.PutLogEvents(request); #elif CORECLR return client.PutLogEventsAsync(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 LogEvent { get; set; } public System.String LogGroupName { get; set; } public System.String LogStreamName { get; set; } public System.String SequenceToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.NextSequenceToken; } } }