Skip to content

StartActivityStreamRequest

Source code in docs_src/capo_rds/types/start_activity_stream_request.py
class StartActivityStreamRequest(TypedDict, closed=True):
    resource_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the DB cluster, for example, <code>arn:aws:rds:us-east-1:12345667890:cluster:das-cluster</code>.</p>"""
    mode: NotRequired["capo_rds.types.activity_stream_mode.ActivityStreamMode"]
    """<p>Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.</p>"""
    kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"""
    apply_immediately: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.</p>"""
    engine_native_audit_fields_included: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.</p>"""

apply_immediately instance-attribute

apply_immediately: NotRequired[BooleanOptional]

Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

engine_native_audit_fields_included instance-attribute

engine_native_audit_fields_included: NotRequired[BooleanOptional]

Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

mode instance-attribute

mode: NotRequired[ActivityStreamMode]

Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

resource_arn instance-attribute

resource_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.