amazonka-kinesis-firehose-2.0: Amazon Kinesis Firehose SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Firehose.StopDeliveryStreamEncryption

Description

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.

Synopsis

Creating a Request

data StopDeliveryStreamEncryption Source #

See: newStopDeliveryStreamEncryption smart constructor.

Constructors

StopDeliveryStreamEncryption' 

Fields

  • deliveryStreamName :: Text

    The name of the delivery stream for which you want to disable server-side encryption (SSE).

Instances

Instances details
ToJSON StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

ToHeaders StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

ToPath StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

ToQuery StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

AWSRequest StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Generic StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Associated Types

type Rep StopDeliveryStreamEncryption :: Type -> Type #

Read StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Show StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

NFData StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Eq StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Hashable StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

type AWSResponse StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

type Rep StopDeliveryStreamEncryption Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

type Rep StopDeliveryStreamEncryption = D1 ('MetaData "StopDeliveryStreamEncryption" "Amazonka.Firehose.StopDeliveryStreamEncryption" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "StopDeliveryStreamEncryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopDeliveryStreamEncryption Source #

Create a value of StopDeliveryStreamEncryption with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StopDeliveryStreamEncryption, stopDeliveryStreamEncryption_deliveryStreamName - The name of the delivery stream for which you want to disable server-side encryption (SSE).

Request Lenses

stopDeliveryStreamEncryption_deliveryStreamName :: Lens' StopDeliveryStreamEncryption Text Source #

The name of the delivery stream for which you want to disable server-side encryption (SSE).

Destructuring the Response

data StopDeliveryStreamEncryptionResponse Source #

Constructors

StopDeliveryStreamEncryptionResponse' 

Fields

Instances

Instances details
Generic StopDeliveryStreamEncryptionResponse Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Read StopDeliveryStreamEncryptionResponse Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Show StopDeliveryStreamEncryptionResponse Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

NFData StopDeliveryStreamEncryptionResponse Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

Eq StopDeliveryStreamEncryptionResponse Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

type Rep StopDeliveryStreamEncryptionResponse Source # 
Instance details

Defined in Amazonka.Firehose.StopDeliveryStreamEncryption

type Rep StopDeliveryStreamEncryptionResponse = D1 ('MetaData "StopDeliveryStreamEncryptionResponse" "Amazonka.Firehose.StopDeliveryStreamEncryption" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "StopDeliveryStreamEncryptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopDeliveryStreamEncryptionResponse Source #

Create a value of StopDeliveryStreamEncryptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StopDeliveryStreamEncryptionResponse', stopDeliveryStreamEncryptionResponse_httpStatus - The response's http status code.

Response Lenses