Skip to content

DeliveryStreamEncryptionConfiguration

Source code in docs_src/capo_firehose/types/delivery_stream_encryption_configuration.py
class DeliveryStreamEncryptionConfiguration(TypedDict, closed=True):
    key_arn: NotRequired[
        "capo_firehose.types.awskms_key_arn_for_sse.AWSKMSKeyARNForSSE"
    ]
    """<p>If <code>KeyType</code> is <code>CUSTOMER_MANAGED_CMK</code>, this field contains the ARN of the customer managed CMK. If <code>KeyType</code> is <code>Amazon Web Services_OWNED_CMK</code>, <code>DeliveryStreamEncryptionConfiguration</code> doesn't contain a value for <code>KeyARN</code>.</p>"""
    key_type: NotRequired["capo_firehose.types.key_type.KeyType"]
    """<p>Indicates the type of customer master key (CMK) that is used for encryption. The default setting is <code>Amazon Web Services_OWNED_CMK</code>. For more information about CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys (CMKs)</a>.</p>"""
    status: NotRequired[
        "capo_firehose.types.delivery_stream_encryption_status.DeliveryStreamEncryptionStatus"
    ]
    """<p>This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see <a>StartDeliveryStreamEncryption</a> and <a>StopDeliveryStreamEncryption</a>. If this status is <code>ENABLING_FAILED</code> or <code>DISABLING_FAILED</code>, it is the status of the most recent attempt to enable or disable SSE, respectively.</p>"""
    failure_description: NotRequired[
        "capo_firehose.types.failure_description.FailureDescription"
    ]
    """<p>Provides details in case one of the following operations fails due to an error related to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>, <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>"""

failure_description instance-attribute

failure_description: NotRequired[FailureDescription]

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

key_arn instance-attribute

key_arn: NotRequired[AWSKMSKeyARNForSSE]

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

key_type instance-attribute

key_type: NotRequired[KeyType]

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

status instance-attribute

status: NotRequired[DeliveryStreamEncryptionStatus]

This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.