Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

Configuration for the AWS CloudWatch service.

This struct holds all necessary credentials and identifiers to authenticate and send logs to a specific CloudWatch Log Group.

§Note

While this configuration is explicit, the underlying SDK can often fall back to environment variables if certain fields are left as default.

Implementations§

Source§

impl Config

Source

pub fn new<S1, S2, S3, S4>( access_key_id: S1, access_key_secret: S2, log_group: S3, region: S4, ) -> Self
where S1: Into<String>, S2: Into<String>, S3: Into<String>, S4: Into<String>,

Creates a new Config instance with required parameters.

§Arguments
  • access_key_id - The AWS Access Key.
  • access_key_secret - The AWS Secret Key.
  • log_group - The target CloudWatch Log Group name.
  • region - The AWS region string.
§Defaults:

provider: “timber-rust”

§Example
let config = Config::new("AKIA...", "secret", "my-logs", "us-east-1");
Source

pub fn get_access_key_id(&self) -> &str

Returns the AWS Access Key ID.

Source

pub fn get_access_key_secret(&self) -> &str

Returns the AWS Secret Access Key.

Source

pub fn get_session_token(&self) -> Option<&str>

Returns the AWS Session Token, if any.

Source

pub fn get_expires_in(&self) -> Option<SystemTime>

Returns the expiration time of the credentials in seconds.

Source

pub fn get_log_group(&self) -> &str

Returns the target CloudWatch Log Group name.

Source

pub fn get_region(&self) -> &str

Returns the AWS Region string.

Source

pub fn get_provider(&self) -> &'static str

Returns the provider name string.

Source

pub fn access_key_id(self, v: impl Into<String>) -> Self

Sets the AWS Access Key ID.

Source

pub fn access_key_secret(self, v: impl Into<String>) -> Self

Sets the AWS Secret Access Key.

Source

pub fn session_token(self, v: Option<impl Into<String>>) -> Self

Sets an optional AWS Session Token.

Source

pub fn expires_in(self, v: Option<SystemTime>) -> Self

Sets the credential expiration time (in seconds).

Source

pub fn log_group(self, v: impl Into<String>) -> Self

Sets the target CloudWatch Log Group.

Source

pub fn region(self, v: impl Into<String>) -> Self

Sets the AWS Region.

Source

pub fn provider(self, v: &'static str) -> Self

Sets the provider name for this configuration.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the configuration for debugging purposes. Note that access_key_secret is masked for security.

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more