/*
* Copyright 2010-2014 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.
*/
/*
* Do not modify this file. This file is generated from the firehose-2015-08-04.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.KinesisFirehose.Model
{
///
/// Container for the parameters to the StartDeliveryStreamEncryption operation.
/// Enables 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 ENABLING
,
/// and then to ENABLED
. The encryption status of a delivery stream is the
/// Status
property in DeliveryStreamEncryptionConfiguration. If the
/// operation fails, the encryption status changes to ENABLING_FAILED
. You
/// can continue to read and write data to your delivery stream while the encryption status
/// is ENABLING
, but the data is not encrypted. It can take up to 5 seconds
/// after the encryption status changes to ENABLED
before all records written
/// to the delivery stream are encrypted. 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 status of a delivery stream, use DescribeDeliveryStream.
///
///
///
/// Even if encryption is currently enabled for a delivery stream, you can still invoke
/// this operation on it to change the ARN of the CMK or both its type and ARN. In this
/// case, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement
/// and creates a grant that enables it to use the new CMK to encrypt and decrypt data
/// and to manage the grant.
///
///
///
/// If a delivery stream already has encryption enabled and then you invoke this operation
/// to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED
,
/// this only means that the attempt to change the CMK failed. In this case, encryption
/// remains enabled with the old CMK.
///
///
///
/// If the encryption status of your delivery stream is ENABLING_FAILED
,
/// you can invoke this operation again.
///
///
///
/// You can only enable SSE for a delivery stream that uses DirectPut
as
/// its source.
///
///
///
/// 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.
///
///
public partial class StartDeliveryStreamEncryptionRequest : AmazonKinesisFirehoseRequest
{
private DeliveryStreamEncryptionConfigurationInput _deliveryStreamEncryptionConfigurationInput;
private string _deliveryStreamName;
///
/// Gets and sets the property DeliveryStreamEncryptionConfigurationInput.
///
/// Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for
/// Server-Side Encryption (SSE).
///
///
public DeliveryStreamEncryptionConfigurationInput DeliveryStreamEncryptionConfigurationInput
{
get { return this._deliveryStreamEncryptionConfigurationInput; }
set { this._deliveryStreamEncryptionConfigurationInput = value; }
}
// Check to see if DeliveryStreamEncryptionConfigurationInput property is set
internal bool IsSetDeliveryStreamEncryptionConfigurationInput()
{
return this._deliveryStreamEncryptionConfigurationInput != null;
}
///
/// Gets and sets the property DeliveryStreamName.
///
/// The name of the delivery stream for which you want to enable server-side encryption
/// (SSE).
///
///
[AWSProperty(Required=true, Min=1, Max=64)]
public string DeliveryStreamName
{
get { return this._deliveryStreamName; }
set { this._deliveryStreamName = value; }
}
// Check to see if DeliveryStreamName property is set
internal bool IsSetDeliveryStreamName()
{
return this._deliveryStreamName != null;
}
}
}