/*******************************************************************************
* 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.MemoryDB;
using Amazon.MemoryDB.Model;
namespace Amazon.PowerShell.Cmdlets.MDB
{
///
/// Returns events related to clusters, security groups, and parameter groups. You can
/// obtain events specific to a particular cluster, security group, or parameter group
/// by providing the name as a parameter. By default, only the events occurring within
/// the last hour are returned; however, you can retrieve up to 14 days' worth of events
/// if necessary.
///
[Cmdlet("Get", "MDBEvent")]
[OutputType("Amazon.MemoryDB.Model.Event")]
[AWSCmdlet("Calls the Amazon MemoryDB DescribeEvents API operation.", Operation = new[] {"DescribeEvents"}, SelectReturnType = typeof(Amazon.MemoryDB.Model.DescribeEventsResponse))]
[AWSCmdletOutput("Amazon.MemoryDB.Model.Event or Amazon.MemoryDB.Model.DescribeEventsResponse",
"This cmdlet returns a collection of Amazon.MemoryDB.Model.Event objects.",
"The service call response (type Amazon.MemoryDB.Model.DescribeEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetMDBEventCmdlet : AmazonMemoryDBClientCmdlet, IExecutor
{
#region Parameter Duration
///
///
/// The number of minutes worth of events to retrieve.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Duration { get; set; }
#endregion
#region Parameter EndTime
///
///
/// The end of the time interval for which to retrieve events, specified in ISO 8601 format.
/// Example: 2017-03-30T07:03:49.555Z
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? EndTime { get; set; }
#endregion
#region Parameter SourceName
///
///
/// The identifier of the event source for which events are returned. If not specified,
/// all sources are included in the response.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String SourceName { get; set; }
#endregion
#region Parameter SourceType
///
///
/// The event source to retrieve events for. If no value is specified, all events are
/// returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.MemoryDB.SourceType")]
public Amazon.MemoryDB.SourceType SourceType { get; set; }
#endregion
#region Parameter StartTime
///
///
/// The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
/// Example: 2017-03-30T07:03:49.555Z
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? StartTime { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of records to include in the response. If more records exist than
/// the specified MaxResults value, a token is included in the response so that the remaining
/// results can be retrieved.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// An optional argument to pass in case the total number of records exceeds the value
/// of MaxResults. If nextToken is returned, there are more results available. The value
/// of nextToken is a unique pagination token for each page. Make the call again using
/// the returned token to retrieve the next page. Keep all other arguments unchanged.
///
///
///
[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 'Events'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MemoryDB.Model.DescribeEventsResponse).
/// Specifying the name of a property of type Amazon.MemoryDB.Model.DescribeEventsResponse 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; } = "Events";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the SourceName parameter.
/// The -PassThru parameter is deprecated, use -Select '^SourceName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SourceName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.SourceName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Duration = this.Duration;
context.EndTime = this.EndTime;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.SourceName = this.SourceName;
context.SourceType = this.SourceType;
context.StartTime = this.StartTime;
// 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.MemoryDB.Model.DescribeEventsRequest();
if (cmdletContext.Duration != null)
{
request.Duration = cmdletContext.Duration.Value;
}
if (cmdletContext.EndTime != null)
{
request.EndTime = cmdletContext.EndTime.Value;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
if (cmdletContext.SourceName != null)
{
request.SourceName = cmdletContext.SourceName;
}
if (cmdletContext.SourceType != null)
{
request.SourceType = cmdletContext.SourceType;
}
if (cmdletContext.StartTime != null)
{
request.StartTime = cmdletContext.StartTime.Value;
}
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.MemoryDB.Model.DescribeEventsResponse CallAWSServiceOperation(IAmazonMemoryDB client, Amazon.MemoryDB.Model.DescribeEventsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon MemoryDB", "DescribeEvents");
try
{
#if DESKTOP
return client.DescribeEvents(request);
#elif CORECLR
return client.DescribeEventsAsync(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.Int32? Duration { get; set; }
public System.DateTime? EndTime { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.String SourceName { get; set; }
public Amazon.MemoryDB.SourceType SourceType { get; set; }
public System.DateTime? StartTime { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Events;
}
}
}