Skip to content

RDS  >  Operations  >  modify_activity_stream

modify_activity_stream

Operation

modify_activity_stream async 

modify_activity_stream(input: ModifyActivityStreamInput, plugins: list[Plugin] | None = None) -> ModifyActivityStreamOutput

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide.

This operation is supported for RDS for Oracle and Microsoft SQL Server.

Parameters:

Name Type Description Default
input ModifyActivityStreamInput

An instance of ModifyActivityStreamInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ModifyActivityStreamOutput

An instance of ModifyActivityStreamOutput.

Input

ModifyActivityStreamInput dataclass

Bases: _SerdeShape

Dataclass for ModifyActivityStreamInput structure.

Attributes

audit_policy_state class-attribute instance-attribute 
audit_policy_state: str | None = ...

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

resource_arn class-attribute instance-attribute 
resource_arn: str | None = ...

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.

Output

ModifyActivityStreamOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyActivityStreamOutput structure.

Attributes

engine_native_audit_fields_included class-attribute instance-attribute 
engine_native_audit_fields_included: bool | None = ...

Indicates whether engine-native audit fields are included in the database activity stream.

kinesis_stream_name class-attribute instance-attribute 
kinesis_stream_name: str | None = ...

The name of the Amazon Kinesis data stream to be used for the database activity stream.

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = ...

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

mode class-attribute instance-attribute 
mode: str | None = ...

The mode of the database activity stream.

policy_status class-attribute instance-attribute 
policy_status: str | None = ...

The status of the modification to the policy state of the database activity stream.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute 
status: str | None = ...

The status of the modification to the database activity stream.