Skip to content

UpdateArchiveRequest

Source code in docs_src/capo_eventbridge/types/update_archive_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class UpdateArchiveRequest(TypedDict, closed=True):
    archive_name: "capo_eventbridge.types.archive_name.ArchiveName"
    """<p>The name of the archive to update.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.archive_description.ArchiveDescription"
    ]
    """<p>The description for the archive.</p>"""
    event_pattern: NotRequired["capo_eventbridge.types.event_pattern.EventPattern"]
    """<p>The event pattern to use to filter events sent to the archive.</p>"""
    retention_days: NotRequired["capo_eventbridge.types.retention_days.RetentionDays"]
    """<p>The number of days to retain events in the archive.</p>"""
    kms_key_identifier: NotRequired[
        "capo_eventbridge.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p> <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html">Identify and view keys</a> in the <i>Key Management Service Developer Guide</i>. </p> <important> <p>If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p> </important>"""

archive_name instance-attribute 

archive_name: ArchiveName

The name of the archive to update.

description instance-attribute 

description: NotRequired[ArchiveDescription]

The description for the archive.

event_pattern instance-attribute 

event_pattern: NotRequired[EventPattern]

The event pattern to use to filter events sent to the archive.

kms_key_identifier instance-attribute 

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

retention_days instance-attribute 

retention_days: NotRequired[RetentionDays]

The number of days to retain events in the archive.