/*******************************************************************************
* 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.KinesisFirehose;
using Amazon.KinesisFirehose.Model;
namespace Amazon.PowerShell.Cmdlets.KINF
{
///
/// Disables server-side encryption (SSE) for the delivery stream.
///
///
///
/// This operation is asynchronous. It returns immediately. When you invoke it, Kinesis
/// Data Firehose first sets the encryption status of the stream to DISABLING
,
/// and then to DISABLED
. You can continue to read and write data to your
/// stream while its status is DISABLING
. It can take up to 5 seconds after
/// the encryption status changes to DISABLED
before all records written
/// to the delivery stream are no longer subject to encryption. To find out whether a
/// record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted
/// and PutRecordBatchOutput$Encrypted, respectively.
///
/// To check the encryption state of a delivery stream, use DescribeDeliveryStream.
///
///
/// If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption
,
/// Kinesis Data Firehose schedules the related KMS grant for retirement and then retires
/// it after it ensures that it is finished delivering records to the destination.
///
/// The StartDeliveryStreamEncryption
and StopDeliveryStreamEncryption
/// operations have a combined limit of 25 calls per delivery stream per 24 hours. For
/// example, you reach the limit if you call StartDeliveryStreamEncryption
/// 13 times and StopDeliveryStreamEncryption
12 times for the same delivery
/// stream in a 24-hour period.
///
///
[Cmdlet("Stop", "KINFDeliveryStreamEncryption", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Kinesis Firehose StopDeliveryStreamEncryption API operation.", Operation = new[] {"StopDeliveryStreamEncryption"}, SelectReturnType = typeof(Amazon.KinesisFirehose.Model.StopDeliveryStreamEncryptionResponse))]
[AWSCmdletOutput("None or Amazon.KinesisFirehose.Model.StopDeliveryStreamEncryptionResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.KinesisFirehose.Model.StopDeliveryStreamEncryptionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class StopKINFDeliveryStreamEncryptionCmdlet : AmazonKinesisFirehoseClientCmdlet, IExecutor
{
#region Parameter DeliveryStreamName
///
///
/// The name of the delivery stream for which you want to disable server-side encryption
/// (SSE).
///
///
#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 DeliveryStreamName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisFirehose.Model.StopDeliveryStreamEncryptionResponse).
/// 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 DeliveryStreamName parameter.
/// The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DeliveryStreamName' 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.DeliveryStreamName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Stop-KINFDeliveryStreamEncryption (StopDeliveryStreamEncryption)"))
{
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.DeliveryStreamName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DeliveryStreamName = this.DeliveryStreamName;
#if MODULAR
if (this.DeliveryStreamName == null && ParameterWasBound(nameof(this.DeliveryStreamName)))
{
WriteWarning("You are passing $null as a value for parameter DeliveryStreamName 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.KinesisFirehose.Model.StopDeliveryStreamEncryptionRequest();
if (cmdletContext.DeliveryStreamName != null)
{
request.DeliveryStreamName = cmdletContext.DeliveryStreamName;
}
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.KinesisFirehose.Model.StopDeliveryStreamEncryptionResponse CallAWSServiceOperation(IAmazonKinesisFirehose client, Amazon.KinesisFirehose.Model.StopDeliveryStreamEncryptionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kinesis Firehose", "StopDeliveryStreamEncryption");
try
{
#if DESKTOP
return client.StopDeliveryStreamEncryption(request);
#elif CORECLR
return client.StopDeliveryStreamEncryptionAsync(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 DeliveryStreamName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}