activity_streams

Creates, updates, deletes, gets or lists an activity_streams resource.

Overview

Name	activity_streams
Type	Resource
Id	aws.rds.activity_streams

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
modify_activity_stream	update	region	ResourceArn, AuditPolicyState	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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
AuditPolicyState	string	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.
ResourceArn	string	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.

UPDATE examples

modify_activity_stream

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.

UPDATE aws.rds.activity_streams
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required
AND ResourceArn = '{{ ResourceArn}}'
AND AuditPolicyState = '{{ AuditPolicyState}}'
RETURNING
engine_native_audit_fields_included,
kinesis_stream_name,
kms_key_id,
mode,
policy_status,
status;