/*******************************************************************************
* 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.RDS;
using Amazon.RDS.Model;
namespace Amazon.PowerShell.Cmdlets.RDS
{
///
/// Changes the audit policy state of a database activity stream to either locked (default)
/// or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write.
/// If your activity stream is started and locked, you can unlock it, customize your audit
/// policy, and then lock your activity stream. Restarting the activity stream isn't required.
/// For more information, see
/// Modifying a database activity stream in the Amazon RDS User Guide.
///
///
///
/// This operation is supported for RDS for Oracle and Microsoft SQL Server.
///
///
[Cmdlet("Edit", "RDSActivityStream", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.RDS.Model.ModifyActivityStreamResponse")]
[AWSCmdlet("Calls the Amazon Relational Database Service ModifyActivityStream API operation.", Operation = new[] {"ModifyActivityStream"}, SelectReturnType = typeof(Amazon.RDS.Model.ModifyActivityStreamResponse))]
[AWSCmdletOutput("Amazon.RDS.Model.ModifyActivityStreamResponse",
"This cmdlet returns an Amazon.RDS.Model.ModifyActivityStreamResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class EditRDSActivityStreamCmdlet : AmazonRDSClientCmdlet, IExecutor
{
#region Parameter AuditPolicyState
///
///
/// The audit policy state. When a policy is unlocked, it is read/write. When it is locked,
/// it is read-only. You can edit your audit policy only when the activity stream is unlocked
/// or stopped.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.RDS.AuditPolicyState")]
public Amazon.RDS.AuditPolicyState AuditPolicyState { get; set; }
#endregion
#region Parameter ResourceArn
///
///
/// The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.
/// For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String ResourceArn { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.ModifyActivityStreamResponse).
/// Specifying the name of a property of type Amazon.RDS.Model.ModifyActivityStreamResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ResourceArn' 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.ResourceArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-RDSActivityStream (ModifyActivityStream)"))
{
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.ResourceArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AuditPolicyState = this.AuditPolicyState;
context.ResourceArn = this.ResourceArn;
// 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.RDS.Model.ModifyActivityStreamRequest();
if (cmdletContext.AuditPolicyState != null)
{
request.AuditPolicyState = cmdletContext.AuditPolicyState;
}
if (cmdletContext.ResourceArn != null)
{
request.ResourceArn = cmdletContext.ResourceArn;
}
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.RDS.Model.ModifyActivityStreamResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.ModifyActivityStreamRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "ModifyActivityStream");
try
{
#if DESKTOP
return client.ModifyActivityStream(request);
#elif CORECLR
return client.ModifyActivityStreamAsync(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.RDS.AuditPolicyState AuditPolicyState { get; set; }
public System.String ResourceArn { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}