aws_sdk_rds/client/
start_activity_stream.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartActivityStream`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`resource_arn(impl Into<String>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::set_resource_arn):<br>required: **true**<br><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><br>
    ///   - [`mode(ActivityStreamMode)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::mode) / [`set_mode(Option<ActivityStreamMode>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::set_mode):<br>required: **true**<br><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><br>
    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::set_kms_key_id):<br>required: **true**<br><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><br>
    ///   - [`apply_immediately(bool)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::apply_immediately) / [`set_apply_immediately(Option<bool>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::set_apply_immediately):<br>required: **false**<br><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><br>
    ///   - [`engine_native_audit_fields_included(bool)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::engine_native_audit_fields_included) / [`set_engine_native_audit_fields_included(Option<bool>)`](crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::set_engine_native_audit_fields_included):<br>required: **false**<br><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><br>
    /// - On success, responds with [`StartActivityStreamOutput`](crate::operation::start_activity_stream::StartActivityStreamOutput) with field(s):
    ///   - [`kms_key_id(Option<String>)`](crate::operation::start_activity_stream::StartActivityStreamOutput::kms_key_id): <p>The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.</p>
    ///   - [`kinesis_stream_name(Option<String>)`](crate::operation::start_activity_stream::StartActivityStreamOutput::kinesis_stream_name): <p>The name of the Amazon Kinesis data stream to be used for the database activity stream.</p>
    ///   - [`status(Option<ActivityStreamStatus>)`](crate::operation::start_activity_stream::StartActivityStreamOutput::status): <p>The status of the database activity stream.</p>
    ///   - [`mode(Option<ActivityStreamMode>)`](crate::operation::start_activity_stream::StartActivityStreamOutput::mode): <p>The mode of the database activity stream.</p>
    ///   - [`apply_immediately(Option<bool>)`](crate::operation::start_activity_stream::StartActivityStreamOutput::apply_immediately): <p>Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.</p>
    ///   - [`engine_native_audit_fields_included(Option<bool>)`](crate::operation::start_activity_stream::StartActivityStreamOutput::engine_native_audit_fields_included): <p>Indicates whether engine-native audit fields are included in the database activity stream.</p>
    /// - On failure, responds with [`SdkError<StartActivityStreamError>`](crate::operation::start_activity_stream::StartActivityStreamError)
    pub fn start_activity_stream(&self) -> crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder {
        crate::operation::start_activity_stream::builders::StartActivityStreamFluentBuilder::new(self.handle.clone())
    }
}